API
⌘K
My Developer Account

PlanNote

A specific plan note within a single plan.

Example Request

curl https://api.planningcenteronline.com/services/v2/service_types/{service_type_id}/plan_templates/{plan_template_id}/notes

View in API Explorer →

Example Object

{
  "type": "PlanNote",
  "id": "1",
  "attributes": {
    "category_name": "string",
    "content": "string",
    "created_at": "2000-01-01T12:00:00Z",
    "updated_at": "2000-01-01T12:00:00Z"
  },
  "relationships": {
    "created_by": {
      "data": {
        "type": "Person",
        "id": "1"
      }
    },
    "plan_note_category": {
      "data": {
        "type": "PlanNoteCategory",
        "id": "1"
      }
    },
    "teams": {
      "data": {
        "type": "Team",
        "id": "1"
      }
    }
  }
}

Attributes

Name Type Description
category_name string
content string
created_at date_time
id primary_key
updated_at date_time

Relationships

Name Type Association Type Note
created_by Person to_one
plan_note_category PlanNoteCategory to_one Required
teams Team to_one

Can Include

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

Order By

Parameter Value Type Description
order created_at string prefix with a hyphen (-created_at) 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
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 /services/v2/service_types/{service_type_id}/plan_templates/{plan_template_id}/notes

Reading

HTTP Method Endpoint
GET /services/v2/service_types/{service_type_id}/plan_templates/{plan_template_id}/notes/{id}

Creating

HTTP Method Endpoint Assignable Attributes
POST /services/v2/service_types/{service_type_id}/plans/{plan_id}/notes
  • content

Updating

HTTP Method Endpoint Assignable Attributes
PATCH /services/v2/service_types/{service_type_id}/plan_templates/{plan_template_id}/notes/{id}
  • content

Deleting

HTTP Method Endpoint
DELETE /services/v2/service_types/{service_type_id}/plan_templates/{plan_template_id}/notes/{id}

Associations

HTTP Method Endpoint Returns 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 PlanNoteCategory

Belongs To

HTTP Method Endpoint Association Details Filter By
GET https://api.planningcenteronline.com/services/v2/service_types/{service_type_id}/plans/{plan_id}/notes Plan
  • team
GET https://api.planningcenteronline.com/services/v2/service_types/{service_type_id}/plan_templates/{plan_template_id}/notes PlanTemplate