API
⌘K
My Developer Account

WorkflowShare

A workflow share defines who can access a workflow.

Example Request

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

View in API Explorer →

Example Object

{
  "type": "WorkflowShare",
  "id": "1",
  "attributes": {
    "group": "value",
    "permission": "value",
    "person_id": "primary_key"
  },
  "relationships": {
    "person": {
      "data": {
        "type": "Person",
        "id": "1"
      }
    },
    "workflow": {
      "data": {
        "type": "Workflow",
        "id": "1"
      }
    }
  }
}

Attributes

Name Type Description
group string Possible values: `No Access`, `Viewer`, `Editor`, or `Manager`
id primary_key
permission string Possible values: `view`, `manage_cards`, or `manage`
person_id primary_key

Relationships

Name Type Association Type Note
person Person to_one
workflow Workflow to_one

Can Include

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

Query By

Name Parameter Type Description Example
permission where[permission] string Query on a specific permission Possible values: `view`, `manage_cards`, or `manage` ?where[permission]=value

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_shares

Reading

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

Creating

HTTP Method Endpoint Assignable Attributes
POST /people/v2/workflows/{workflow_id}/shares
  • group
  • permission
  • person_id

Updating

HTTP Method Endpoint Assignable Attributes
PATCH /people/v2/people/{person_id}/workflow_shares/{id}
  • group
  • permission

Deleting

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

Associations

HTTP Method Endpoint Returns Details Filter By
GET https://api.planningcenteronline.com/people/v2/people/{person_id}/workflow_shares/{workflow_share_id}/person Person

Belongs To

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