Person - Calendar API - Planning Center

Example Request

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

View in API Explorer →

Example Object

{
  "type": "Person",
  "id": "1",
  "attributes": {
    "avatar_url": "string",
    "can_edit_people": true,
    "can_edit_resources": true,
    "can_edit_rooms": true,
    "child": true,
    "contact_data": "string",
    "created_at": "2000-01-01T12:00:00Z",
    "event_permissions_type": "string",
    "first_name": "string",
    "gender": "string",
    "has_access": true,
    "last_name": "string",
    "member_of_approval_groups": true,
    "middle_name": "string",
    "name": "string",
    "name_prefix": "string",
    "name_suffix": "string",
    "pending_request_count": 1,
    "people_permissions_type": "string",
    "permissions": 1,
    "resolves_conflicts": true,
    "resources_permissions_type": "string",
    "room_permissions_type": "string",
    "site_administrator": true,
    "status": "value",
    "updated_at": "2000-01-01T12:00:00Z"
  },
  "relationships": {}
}

Attributes

Name	Type	Description
`avatar_url`	`string`	Path to where the avatar image is stored
`can_edit_people`	`boolean`	Indicates whether the person can edit other people
`can_edit_resources`	`boolean`	Indicates whether the person can edit resources
`can_edit_rooms`	`boolean`	Indicates whether the person can edit rooms
`child`	`boolean`	Indicates whether the person is a child
`contact_data`	`string`	An object containing the person's contact data. This can include an array of `email_addresses`, `addresses` and `phone_numbers`
`created_at`	`date_time`	UTC time at which the person was created
`event_permissions_type`	`string`	Event permissions for the person
`first_name`	`string`	The person's first name
`gender`	`string`	`M` indicates male, `F` indicates female
`has_access`	`boolean`	Indicates whether the person has access to Calendar
`id`	`primary_key`	Unique identifier for the person
`last_name`	`string`	The person's last name
`member_of_approval_groups`	`boolean`	Indicates whether the person is a member of at least one approval group Only available when requested with the `?fields` param
`middle_name`	`string`	The person's middle name
`name`	`string`	The person's first name, last name, and name suffix
`name_prefix`	`string`	Possible values: - `Mr.` - `Mrs.` - `Ms.` - `Miss` - `Dr.` - `Rev.`
`name_suffix`	`string`	Possible values: - `Jr.` - `Sr.` - `Ph.D.` - `II` - `III`
`pending_request_count`	`integer`	If the person is a member of an approval group, the number of EventResourceRequests needing resolution. If `resolves_conflicts` is `true`, the count will also include the number of Conflicts needing resolution.
`people_permissions_type`	`string`	People permissions for the person
`permissions`	`integer`	Integer that corresponds to the person's permissions in Calendar
`resolves_conflicts`	`boolean`	Indicates whether the person is able to resolve Conflicts
`resources_permissions_type`	`string`	Resource permissions for the person
`room_permissions_type`	`string`	Room permissions for the person
`site_administrator`	`boolean`	Indicates whether the person is a Organization Administrator
`status`	`string`	Possible values: - `active`: The person is marked "active" in People - `inactive`: The person is marked "inactive" in People Possible values: `active`, `pending`, or `inactive`
`updated_at`	`date_time`	UTC time at which the person was updated

Can Include

Parameter	Value	Description	Assignable
include	organization	include associated organization

Order By

Parameter	Value	Type	Description
order	created_at	string	prefix with a hyphen (-created_at) to reverse the order
order	first_name	string	prefix with a hyphen (-first_name) to reverse the order
order	last_name	string	prefix with a hyphen (-last_name) to reverse the order
order	resolves_conflicts	string	prefix with a hyphen (-resolves_conflicts) 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`
first_name	`where[first_name]`	string	Query on a specific first_name	`?where[first_name]=string`
last_name	`where[last_name]`	string	Query on a specific last_name	`?where[last_name]=string`
middle_name	`where[middle_name]`	string	Query on a specific middle_name	`?where[middle_name]=string`
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	`/calendar/v2/people`

Reading

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

Associations

HTTP Method	Endpoint	Returns	Details	Filter By
GET	`https://api.planningcenteronline.com/calendar/v2/people/{person_id}/event_resource_requests`	EventResourceRequest		`awaiting_response` `future` `not_in_conflict` `not_overbooked` `overbooked`
GET	`https://api.planningcenteronline.com/calendar/v2/people/{person_id}/organization`	Organization

Belongs To

HTTP Method	Endpoint	Association	Filter By
GET	`https://api.planningcenteronline.com/calendar/v2/conflicts/{conflict_id}/resolved_by`	Conflict
GET	`https://api.planningcenteronline.com/calendar/v2/events/{event_id}/owner`	Event
GET	`https://api.planningcenteronline.com/calendar/v2/event_resource_requests/{event_resource_request_id}/created_by`	EventResourceRequest
GET	`https://api.planningcenteronline.com/calendar/v2/event_resource_requests/{event_resource_request_id}/updated_by`	EventResourceRequest
GET	`https://api.planningcenteronline.com/calendar/v2/people`	Organization	`active` `event_owners`
GET	`https://api.planningcenteronline.com/calendar/v2/resource_approval_groups/{resource_approval_group_id}/people`	ResourceApprovalGroup