WorkflowCardActivity - People API

Example Request

curl https://api.planningcenteronline.com/people/v2/people/{person_id}/workflow_cards/{workflow_card_id}/activities

View in API Explorer →

Example Object

{
  "type": "WorkflowCardActivity",
  "id": "1",
  "attributes": {
    "attachments_meta": [],
    "attachments_urls": [],
    "automation_url": "string",
    "comment": "string",
    "content": "string",
    "content_is_html": true,
    "created_at": "2000-01-01T12:00:00Z",
    "form_submission_url": "string",
    "person_avatar_url": "string",
    "person_name": "string",
    "reassigned_to_avatar_url": "string",
    "reassigned_to_name": "string",
    "subject": "string",
    "type": "string",
    "updated_at": "2000-01-01T12:00:00Z"
  },
  "relationships": {
    "person": {
      "data": {
        "type": "Person",
        "id": "1"
      }
    },
    "reassigned_to": {
      "data": {
        "type": "Person",
        "id": "1"
      }
    },
    "workflow_card": {
      "data": {
        "type": "WorkflowCard",
        "id": "1"
      }
    },
    "workflow_step": {
      "data": {
        "type": "WorkflowStep",
        "id": "1"
      }
    }
  }
}

Attributes

Name	Type	Description
`attachments_meta`	`array`
`attachments_urls`	`array`
`automation_url`	`string`
`comment`	`string`
`content`	`string`
`content_is_html`	`boolean`
`created_at`	`date_time`
`form_submission_url`	`string`
`id`	`primary_key`
`person_avatar_url`	`string`
`person_name`	`string`
`reassigned_to_avatar_url`	`string`
`reassigned_to_name`	`string`
`subject`	`string`
`type`	`string`
`updated_at`	`date_time`

Relationships

Name	Type	Association Type	Note
person	Person	to_one	The person the `person_name` attribute refers to. Null when the activity was performed by an integration rather than a person.
reassigned_to	Person	to_one	The person named by the `reassigned_to_name` attribute.
workflow_card	WorkflowCard	to_one
workflow_step	WorkflowStep	to_one	Only available when `type` attribute is `completion`, `skip`, `reversal`, `automation_success`, `automation_failure`, `manual_action_success`, or `manual_action_failure`.

Order By

Parameter	Value	Type	Description
order	created_at	string	prefix with a hyphen (-created_at) to reverse the order
order	id	string	prefix with a hyphen (-id) 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`
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/people/{person_id}/workflow_cards/{workflow_card_id}/activities`

Reading

HTTP Method	Endpoint
GET	`/people/v2/people/{person_id}/workflow_cards/{workflow_card_id}/activities/{id}`

Deleting

HTTP Method	Endpoint
DELETE	`/people/v2/people/{person_id}/workflow_cards/{workflow_card_id}/activities/{id}`

Belongs To

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