API
⌘K
My Developer Account

WorkflowCardNote

Workflow Note is a note that has been made on a Workflow Card

Example Request

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

View in API Explorer →

Example Object

{
  "type": "WorkflowCardNote",
  "id": "1",
  "attributes": {
    "created_at": "2000-01-01T12:00:00Z",
    "note": "string"
  },
  "relationships": {}
}

Attributes

Name Type Description
created_at date_time
id primary_key
note string

Order By

Parameter Value Type Description
order created_at string

prefix with a hyphen (-created_at) 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_cards/{workflow_card_id}/notes

Reading

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

Creating

HTTP Method Endpoint Assignable Attributes
POST /people/v2/people/{person_id}/workflow_cards/{workflow_card_id}/notes
  • note

Notes:

If you want to also create a matching profile note in the note category of your choice, pass in the ID of the note category. { "data": { "attributes": { "note": "this is a new note!", "note_category_id": 123 } } } The note_category_id is not actually stored on the workflow card note itself, so if you need to edit or delete the resulting profile note, you will need to do so via people/v2/notes.

You can GET all the existing note categories at /people/v2/note_categories.

Belongs To

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