WorkflowStep - People API - Planning Center

Example Request

curl https://api.planningcenteronline.com/people/v2/workflows/{workflow_id}/steps

View in API Explorer →

Example Object

{
  "type": "WorkflowStep",
  "id": "1",
  "attributes": {
    "auto_snooze_days": 1,
    "auto_snooze_interval": "value",
    "auto_snooze_value": 1,
    "created_at": "2000-01-01T12:00:00Z",
    "default_assignee_id": "primary_key",
    "description": "string",
    "expected_response_time_in_days": 1,
    "my_ready_card_count": 1,
    "name": "string",
    "sequence": 1,
    "total_ready_card_count": 1,
    "updated_at": "2000-01-01T12:00:00Z"
  },
  "relationships": {
    "default_assignee": {
      "data": {
        "type": "Person",
        "id": "1"
      }
    },
    "workflow": {
      "data": {
        "type": "Workflow",
        "id": "1"
      }
    }
  }
}

Attributes

Name	Type	Description
`auto_snooze_days`	`integer`
`auto_snooze_interval`	`string`	Valid values are `day`, `week`, or `month` Possible values: `day`, `week`, or `month`
`auto_snooze_value`	`integer`	Must be a positive number
`created_at`	`date_time`
`default_assignee_id`	`primary_key`
`description`	`string`
`expected_response_time_in_days`	`integer`
`id`	`primary_key`
`my_ready_card_count`	`integer`
`name`	`string`
`sequence`	`integer`
`total_ready_card_count`	`integer`
`updated_at`	`date_time`

Relationships

Name	Type	Association Type	Note
default_assignee	Person	to_one
workflow	Workflow	to_one

Can Include

Parameter	Value	Description	Assignable
include	default_assignee	include associated default_assignee	create and update

Order By

Parameter	Value	Type	Description
order	created_at	string	prefix with a hyphen (-created_at) to reverse the order
order	name	string	prefix with a hyphen (-name) to reverse the order
order	sequence	string	prefix with a hyphen (-sequence) to reverse the order
order	updated_at	string	prefix with a hyphen (-updated_at) to reverse the order

Query By

Name	Parameter	Type	Description	Example
created_at	`where[created_at]`	date_time	Query on a specific created_at	`?where[created_at]=2000-01-01T12:00:00Z`
name	`where[name]`	string	Query on a specific name	`?where[name]=string`
updated_at	`where[updated_at]`	date_time	Query on a specific updated_at	`?where[updated_at]=2000-01-01T12:00:00Z`

Pagination

Name	Parameter	Type	Description
per_page	per_page	integer	how many records to return per page (min=1, max=100, default=25)
offset	offset	integer	get results from given offset

Endpoints

Listing

HTTP Method	Endpoint
GET	`/people/v2/workflows/{workflow_id}/steps`

Reading

HTTP Method	Endpoint
GET	`/people/v2/workflows/{workflow_id}/steps/{id}`

Creating

HTTP Method	Endpoint	Assignable Attributes
POST	`/people/v2/workflows/{workflow_id}/steps`	sequence name description expected_response_time_in_days default_assignee_id auto_snooze_value auto_snooze_interval

Updating

HTTP Method	Endpoint	Assignable Attributes
PATCH	`/people/v2/workflows/{workflow_id}/steps/{id}`	sequence name description expected_response_time_in_days default_assignee_id auto_snooze_value auto_snooze_interval

Deleting

HTTP Method	Endpoint
DELETE	`/people/v2/workflows/{workflow_id}/steps/{id}`

Associations

HTTP Method	Endpoint	Returns	Details	Filter By
GET	`https://api.planningcenteronline.com/people/v2/workflows/{workflow_id}/steps/{workflow_step_id}/assignee_summaries`	WorkflowStepAssigneeSummary
GET	`https://api.planningcenteronline.com/people/v2/workflows/{workflow_id}/steps/{workflow_step_id}/default_assignee`	Person

Belongs To

HTTP Method	Endpoint	Association	Details	Filter By
GET	`https://api.planningcenteronline.com/people/v2/people/{person_id}/workflow_cards/{workflow_card_id}/current_step`	WorkflowCard
GET	`https://api.planningcenteronline.com/people/v2/workflows/{workflow_id}/steps`	Workflow