WorkflowAssigneeWorkflowSummary - People API

Example Request

curl https://api.planningcenteronline.com/people/v2/people/{person_id}/workflow_assignee_workflow_summaries

View in API Explorer →

Example Object

{
  "type": "WorkflowAssigneeWorkflowSummary",
  "id": "1",
  "attributes": {
    "overdue_count": 1,
    "ready_count": 1,
    "snoozed_count": 1,
    "workflow_name": "string"
  },
  "relationships": {
    "workflow": {
      "data": {
        "type": "Workflow",
        "id": "1"
      }
    },
    "person": {
      "data": {
        "type": "Person",
        "id": "1"
      }
    }
  }
}

Attributes

Name	Type	Description
`id`	`primary_key`
`overdue_count`	`integer`
`ready_count`	`integer`
`snoozed_count`	`integer`
`workflow_name`	`string`

Relationships

Name	Type	Association Type	Note
workflow	Workflow	to_one
person	Person	to_one

Order By

Parameter	Value	Type	Description
order	overdue_count	string	prefix with a hyphen (-overdue_count) to reverse the order
order	ready_count	string	prefix with a hyphen (-ready_count) to reverse the order
order	snoozed_count	string	prefix with a hyphen (-snoozed_count) to reverse the order
order	workflow_name	string	prefix with a hyphen (-workflow_name) to reverse the order

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/people/{person_id}/workflow_assignee_workflow_summaries`

Reading

HTTP Method	Endpoint
GET	`/people/v2/people/{person_id}/workflow_assignee_workflow_summaries/{id}`

Belongs To

HTTP Method	Endpoint	Association	Details	Filter By
GET	`https://api.planningcenteronline.com/people/v2/people/{person_id}/workflow_assignee_workflow_summaries`	Person