API
⌘K
My Developer Account

PlanNoteCategory

A category of plan notes for an entire Service Type.

Example Request

curl https://api.planningcenteronline.com/services/v2/service_types/{service_type_id}/plan_note_categories

View in API Explorer →

Example Object

{
  "type": "PlanNoteCategory",
  "id": "1",
  "attributes": {
    "created_at": "2000-01-01T12:00:00Z",
    "deleted_at": "2000-01-01T12:00:00Z",
    "name": "string",
    "sequence": 1,
    "updated_at": "2000-01-01T12:00:00Z"
  },
  "relationships": {
    "service_type": {
      "data": {
        "type": "ServiceType",
        "id": "1"
      }
    },
    "teams": {
      "data": {
        "type": "Team",
        "id": "1"
      }
    }
  }
}

Attributes

Name Type Description
created_at date_time
deleted_at date_time
id primary_key
name string
sequence integer
updated_at date_time

Relationships

Name Type Association Type Note
service_type ServiceType to_one
teams Team to_one

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 /services/v2/service_types/{service_type_id}/plan_note_categories

Reading

HTTP Method Endpoint
GET /services/v2/service_types/{service_type_id}/plan_note_categories/{id}

Belongs To

HTTP Method Endpoint Association Details Filter By
GET https://api.planningcenteronline.com/services/v2/service_types/{service_type_id}/plan_templates/{plan_template_id}/notes/{plan_note_id}/plan_note_category PlanNote
GET https://api.planningcenteronline.com/services/v2/service_types/{service_type_id}/plan_note_categories ServiceType