API
⌘K
My Developer Account

WorkflowCard

A Card

Example Request 

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

View in API Explorer →

Example Object 

{
  "type": "WorkflowCard",
  "id": "1",
  "attributes": {
    "calculated_due_at_in_days_ago": 1,
    "completed_at": "2000-01-01T12:00:00Z",
    "created_at": "2000-01-01T12:00:00Z",
    "flagged_for_notification_at": "2000-01-01T12:00:00Z",
    "moved_to_step_at": "2000-01-01T12:00:00Z",
    "overdue": true,
    "removed_at": "2000-01-01T12:00:00Z",
    "snooze_until": "2000-01-01T12:00:00Z",
    "stage": "string",
    "sticky_assignment": true,
    "updated_at": "2000-01-01T12:00:00Z"
  },
  "relationships": {
    "assignee": {
      "data": {
        "type": "Assignee",
        "id": "1"
      }
    },
    "person": {
      "data": {
        "type": "Person",
        "id": "1"
      }
    },
    "workflow": {
      "data": {
        "type": "Workflow",
        "id": "1"
      }
    },
    "current_step": {
      "data": {
        "type": "WorkflowStep",
        "id": "1"
      }
    }
  }
}

Attributes

Name Type Description
calculated_due_at_in_days_ago integer
completed_at date_time
created_at date_time
flagged_for_notification_at date_time
id primary_key
moved_to_step_at date_time
overdue boolean
removed_at date_time
snooze_until date_time
stage string
sticky_assignment boolean
updated_at date_time

Relationships

Name Type Association Type Note
assignee Assignee to_one
person Person to_one
workflow Workflow to_one
current_step WorkflowStep to_one

Can Include

Parameter Value Description Assignable
include assignee

include associated assignee

 create and update
include current_step

include associated current_step

 create and update
include person

include associated person

 create and update
include workflow

include associated workflow

 create and update

Order By

Parameter Value Type Description
order completed_at string

prefix with a hyphen (-completed_at) to reverse the order
order created_at string

prefix with a hyphen (-created_at) to reverse the order
order first_name string

prefix with a hyphen (-first_name) to reverse the order
order flagged_for_notification_at string

prefix with a hyphen (-flaggedfornotification_at) to reverse the order
order last_name string

prefix with a hyphen (-last_name) to reverse the order
order moved_to_step_at string

prefix with a hyphen (-movedtostep_at) to reverse the order
order removed_at string

prefix with a hyphen (-removed_at) to reverse the order
order stage string

prefix with a hyphen (-stage) 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
assignee_id where[assignee_id] integer

Query on a related assignee

 ?where[assignee_id]=1
overdue where[overdue] boolean

Query on a specific overdue

 ?where[overdue]=true
stage where[stage] string

Query on a specific stage

 ?where[stage]=string

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

Reading

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

Creating

HTTP Method Endpoint Assignable Attributes
POST /people/v2/workflows/{workflow_id}/cards
  • sticky_assignment
  • assignee_id
  • person_id

Updating

HTTP Method Endpoint Assignable Attributes
PATCH /people/v2/people/{person_id}/workflow_cards/{id}
  • sticky_assignment
  • assignee_id
  • person_id

Deleting

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

Actions

HTTP Method Endpoint Description
POST https://api.planningcenteronline.com/people/v2/people/{person_id}/workflow_cards/{workflow_card_id}/go_back

Move a Workflow Card back to the previous step.
POST https://api.planningcenteronline.com/people/v2/people/{person_id}/workflow_cards/{workflow_card_id}/promote

Move a Workflow Card to the next step.
POST https://api.planningcenteronline.com/people/v2/people/{person_id}/workflow_cards/{workflow_card_id}/remove

Removes a card
POST https://api.planningcenteronline.com/people/v2/people/{person_id}/workflow_cards/{workflow_card_id}/restore

Restore a card
POST https://api.planningcenteronline.com/people/v2/people/{person_id}/workflow_cards/{workflow_card_id}/send_email

Sends an email to the subject of the card
POST https://api.planningcenteronline.com/people/v2/people/{person_id}/workflow_cards/{workflow_card_id}/skip_step

Move a Workflow Card to the next step without completing the current step.
POST https://api.planningcenteronline.com/people/v2/people/{person_id}/workflow_cards/{workflow_card_id}/snooze

Snoozes a card for a specific duration
POST https://api.planningcenteronline.com/people/v2/people/{person_id}/workflow_cards/{workflow_card_id}/unsnooze

Unsnoozes a card

Associations

HTTP Method Endpoint Returns Details Filter By
GET https://api.planningcenteronline.com/people/v2/people/{person_id}/workflow_cards/{workflow_card_id}/activities WorkflowCardActivity
GET https://api.planningcenteronline.com/people/v2/people/{person_id}/workflow_cards/{workflow_card_id}/assignee Person
GET https://api.planningcenteronline.com/people/v2/people/{person_id}/workflow_cards/{workflow_card_id}/current_step WorkflowStep
GET https://api.planningcenteronline.com/people/v2/people/{person_id}/workflow_cards/{workflow_card_id}/notes WorkflowCardNote
GET https://api.planningcenteronline.com/people/v2/people/{person_id}/workflow_cards/{workflow_card_id}/person Person
GET https://api.planningcenteronline.com/people/v2/people/{person_id}/workflow_cards/{workflow_card_id}/workflow Workflow

Belongs To

HTTP Method Endpoint Association Details Filter By
GET https://api.planningcenteronline.com/people/v2/people/{person_id}/workflow_cards Person
  • assigned
GET https://api.planningcenteronline.com/people/v2/workflows/{workflow_id}/cards Workflow