API
⌘K
My Developer Account

NoteCategory

A Note Category

Example Request

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

View in API Explorer →

Example Object

{
  "type": "NoteCategory",
  "id": "1",
  "attributes": {
    "created_at": "2000-01-01T12:00:00Z",
    "locked": true,
    "name": "string",
    "organization_id": "primary_key",
    "updated_at": "2000-01-01T12:00:00Z"
  },
  "relationships": {
    "organization": {
      "data": {
        "type": "Organization",
        "id": "1"
      }
    }
  }
}

Attributes

Name Type Description
created_at date_time
id primary_key
locked boolean
name string
organization_id primary_key
updated_at date_time

Relationships

Name Type Association Type Note
organization Organization to_one

Can Include

Parameter Value Description Assignable
include shares include associated shares
include subscribers include associated subscribers
include subscriptions include associated subscriptions

Order By

Parameter Value Type Description
order created_at string prefix with a hyphen (-created_at) to reverse the order
order locked string prefix with a hyphen (-locked) to reverse the order
order name string prefix with a hyphen (-name) to reverse the order
order organization_id string prefix with a hyphen (-organization_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
locked where[locked] boolean Query on a specific locked ?where[locked]=true
name where[name] string Query on a specific name ?where[name]=string
organization_id where[organization_id] primary_key Query on a specific organization_id ?where[organization_id]=primary_key
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/note_categories

Reading

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

Creating

HTTP Method Endpoint Assignable Attributes
POST /people/v2/note_categories
  • name

Updating

HTTP Method Endpoint Assignable Attributes
PATCH /people/v2/note_categories/{id}
  • name

Deleting

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

Associations

HTTP Method Endpoint Returns Details Filter By
GET https://api.planningcenteronline.com/people/v2/note_categories/{note_category_id}/shares NoteCategoryShare
GET https://api.planningcenteronline.com/people/v2/note_categories/{note_category_id}/subscribers Person
GET https://api.planningcenteronline.com/people/v2/note_categories/{note_category_id}/subscriptions NoteCategorySubscription

Belongs To

HTTP Method Endpoint Association Details Filter By
GET https://api.planningcenteronline.com/people/v2/notes/{note_id}/category Note
GET https://api.planningcenteronline.com/people/v2/note_categories Organization
  • view_creatable