WorkflowStepAssigneeSummary - People API

Example Request

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

View in API Explorer →

Example Object

{
  "type": "WorkflowStepAssigneeSummary",
  "id": "1",
  "attributes": {
    "ready_count": 1,
    "snoozed_count": 1
  },
  "relationships": {
    "person": {
      "data": {
        "type": "Person",
        "id": "1"
      }
    },
    "step": {
      "data": {
        "type": "Step",
        "id": "1"
      }
    }
  }
}

Attributes

Name	Type	Description
`id`	`primary_key`
`ready_count`	`integer`
`snoozed_count`	`integer`

Relationships

Name	Type	Association Type	Note
person	Person	to_one
step	Step	to_one

Can Include

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

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/{step_id}/assignee_summaries`

Reading

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

Associations

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

Belongs To

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