Note - People API - Planning Center

Example Request

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

View in API Explorer →

Example Object

{
  "type": "Note",
  "id": "1",
  "attributes": {
    "created_at": "2000-01-01T12:00:00Z",
    "created_by_id": "primary_key",
    "display_date": "2000-01-01T12:00:00Z",
    "note": "string",
    "note_category_id": "primary_key",
    "organization_id": "primary_key",
    "person_id": "primary_key",
    "updated_at": "2000-01-01T12:00:00Z"
  },
  "relationships": {
    "note_category": {
      "data": {
        "type": "NoteCategory",
        "id": "1"
      }
    },
    "organization": {
      "data": {
        "type": "Organization",
        "id": "1"
      }
    },
    "person": {
      "data": {
        "type": "Person",
        "id": "1"
      }
    },
    "created_by": {
      "data": {
        "type": "Person",
        "id": "1"
      }
    }
  }
}

Attributes

Name	Type	Description
`created_at`	`date_time`
`created_by_id`	`primary_key`
`display_date`	`date_time`
`id`	`primary_key`
`note`	`string`
`note_category_id`	`primary_key`
`organization_id`	`primary_key`
`person_id`	`primary_key`
`updated_at`	`date_time`

Relationships

Name	Type	Association Type
note_category	NoteCategory	to_one
organization	Organization	to_one
person	Person	to_one
created_by	Person	to_one

Can Include

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

Order By

Parameter	Value	Type	Description
order	created_at	string	prefix with a hyphen (-created_at) to reverse the order
order	display_date	string	prefix with a hyphen (-display_date) to reverse the order
order	id	string	prefix with a hyphen (-id) to reverse the order
order	note	string	prefix with a hyphen (-note) to reverse the order
order	note_category_id	string	prefix with a hyphen (-notecategoryid) 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
note	`where[note]`	string	Query on a specific note	`?where[note]=string`
note_category_id	`where[note_category_id]`	primary_key	Query on a specific notecategoryid	`?where[note_category_id]=primary_key`

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/notes`

Reading

HTTP Method	Endpoint
GET	`/people/v2/notes/{id}`

Creating

HTTP Method	Endpoint	Assignable Attributes
POST	`/people/v2/people/{person_id}/notes`	note created_at updated_at display_date note_category_id

Updating

HTTP Method	Endpoint	Assignable Attributes
PATCH	`/people/v2/notes/{id}`	note created_at updated_at display_date note_category_id

Deleting

HTTP Method	Endpoint
DELETE	`/people/v2/notes/{id}`

Associations

HTTP Method	Endpoint	Returns
GET	`https://api.planningcenteronline.com/people/v2/notes/{note_id}/category`	NoteCategory
GET	`https://api.planningcenteronline.com/people/v2/notes/{note_id}/created_by`	Person
GET	`https://api.planningcenteronline.com/people/v2/notes/{note_id}/person`	Person

Belongs To

HTTP Method	Endpoint	Association	Details	Filter By
GET	`https://api.planningcenteronline.com/people/v2/notes`	Organization
GET	`https://api.planningcenteronline.com/people/v2/people/{person_id}/notes`	Person