API
⌘K
My Developer Account

Workflow

A Workflow

Example Request 

curl https://api.planningcenteronline.com/people/v2/workflows

View in API Explorer →

Example Object 

{
  "type": "Workflow",
  "id": "1",
  "attributes": {
    "archived_at": "2000-01-01T12:00:00Z",
    "campus_id": "primary_key",
    "completed_card_count": 1,
    "created_at": "2000-01-01T12:00:00Z",
    "deleted_at": "2000-01-01T12:00:00Z",
    "my_due_soon_card_count": 1,
    "my_overdue_card_count": 1,
    "my_ready_card_count": 1,
    "name": "string",
    "recently_viewed": true,
    "total_cards_count": 1,
    "total_overdue_card_count": 1,
    "total_ready_and_snoozed_card_count": 1,
    "total_ready_card_count": 1,
    "total_steps_count": 1,
    "total_unassigned_card_count": 1,
    "total_unassigned_steps_count": 1,
    "updated_at": "2000-01-01T12:00:00Z",
    "workflow_category_id": "primary_key"
  },
  "relationships": {
    "workflow_category": {
      "data": {
        "type": "WorkflowCategory",
        "id": "1"
      }
    },
    "campus": {
      "data": {
        "type": "Campus",
        "id": "1"
      }
    }
  }
}

Attributes

Name Type Description
archived_at date_time
campus_id primary_key
completed_card_count integer
created_at date_time
deleted_at date_time
id primary_key
my_due_soon_card_count integer

Only available when requested with the ?fields param
my_overdue_card_count integer

Only available when requested with the ?fields param
my_ready_card_count integer
name string
recently_viewed boolean
total_cards_count integer
total_overdue_card_count integer
total_ready_and_snoozed_card_count integer
total_ready_card_count integer
total_steps_count integer
total_unassigned_card_count integer
total_unassigned_steps_count integer
updated_at date_time
workflow_category_id primary_key

Relationships

Name Type Association Type Note
workflow_category WorkflowCategory to_one
campus Campus to_one

Can Include

Parameter Value Description Assignable
include category

include associated category
include shares

include associated shares
include steps

include associated steps

Order By

Parameter Value Type Description
order archived_at string

prefix with a hyphen (-archived_at) to reverse the order
order campus_id string

prefix with a hyphen (-campus_id) to reverse the order
order campus_name string

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

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

prefix with a hyphen (-deleted_at) to reverse the order
order my_ready_card_count string

prefix with a hyphen (-myreadycard_count) to reverse the order
order name string

prefix with a hyphen (-name) to reverse the order
order total_overdue_card_count string

prefix with a hyphen (-totaloverduecard_count) to reverse the order
order total_ready_card_count string

prefix with a hyphen (-totalreadycard_count) to reverse the order
order total_unassigned_card_count string

prefix with a hyphen (-totalunassignedcard_count) to reverse the order
order updated_at string

prefix with a hyphen (-updated_at) to reverse the order
order workflow_category_id string

prefix with a hyphen (-workflowcategoryid) to reverse the order
order workflow_category_name string

prefix with a hyphen (-workflowcategoryname) to reverse the order

Query By

Name Parameter Type Description Example
archived_at where[archived_at] date_time

Query on a specific archived_at

 ?where[archived_at]=2000-01-01T12:00:00Z
campus_id where[campus_id] primary_key

Query on a specific campus_id

 ?where[campus_id]=primary_key
created_at where[created_at] date_time

Query on a specific created_at

 ?where[created_at]=2000-01-01T12:00:00Z
deleted_at where[deleted_at] date_time

Query on a specific deleted_at

 ?where[deleted_at]=2000-01-01T12:00:00Z
id where[id] primary_key

Query on a specific id

 ?where[id]=primary_key
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
workflow_category_id where[workflow_category_id] primary_key

Query on a specific workflowcategoryid

 ?where[workflow_category_id]=primary_key

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

Reading

HTTP Method Endpoint
GET /people/v2/workflows/{id}

Creating

HTTP Method Endpoint Assignable Attributes
POST /people/v2/workflows
  • name
  • campus_id
  • workflow_category_id

Updating

HTTP Method Endpoint Assignable Attributes
PATCH /people/v2/workflows/{id}
  • name
  • campus_id
  • workflow_category_id

Deleting

HTTP Method Endpoint
DELETE /people/v2/workflows/{id}

Associations

HTTP Method Endpoint Returns Details Filter By
GET https://api.planningcenteronline.com/people/v2/workflows/{workflow_id}/cards WorkflowCard
GET https://api.planningcenteronline.com/people/v2/workflows/{workflow_id}/category WorkflowCategory
GET https://api.planningcenteronline.com/people/v2/workflows/{workflow_id}/shared_people Person
GET https://api.planningcenteronline.com/people/v2/workflows/{workflow_id}/shares WorkflowShare
GET https://api.planningcenteronline.com/people/v2/workflows/{workflow_id}/steps WorkflowStep

Belongs To

HTTP Method Endpoint Association Details Filter By
GET https://api.planningcenteronline.com/people/v2/workflows Organization
  • archived
  • has_my_cards
  • manage_cards_allowed
  • not_archived
  • only_deleted
  • recently_deleted
  • recently_viewed
  • unassigned
  • with_deleted
  • with_recoverable
  • with_steps
GET https://api.planningcenteronline.com/people/v2/people/{person_id}/workflow_cards/{workflow_card_id}/workflow WorkflowCard