Person

An attendee, volunteer or administrator.

Usually, a person who checked in will be present as a Person. In some cases, they may not be present: - The person was manually deleted from the admin interface - The check-in was created as a "Visitor - Label Only" (which doesn't create a corresponding person record)

Example Request

curl https://api.planningcenteronline.com/check-ins/v2/people

View in API Explorer →

Example Object

{
  "type": "Person",
  "id": "1",
  "attributes": {
    "addresses": [],
    "avatar_url": "string",
    "birthdate": "2000-01-01",
    "check_in_count": 1,
    "child": true,
    "created_at": "2000-01-01T12:00:00Z",
    "demographic_avatar_url": "string",
    "email_addresses": [],
    "first_name": "string",
    "gender": "string",
    "grade": 1,
    "headcounter": true,
    "ignore_filters": true,
    "last_checked_in_at": "2000-01-01T12:00:00Z",
    "last_name": "string",
    "medical_notes": "string",
    "middle_name": "string",
    "name": "string",
    "name_prefix": "string",
    "name_suffix": "string",
    "passed_background_check": true,
    "permission": "string",
    "phone_numbers": [],
    "top_permission": "string",
    "updated_at": "2000-01-01T12:00:00Z"
  },
  "relationships": {}
}

Attributes

Name	Type	Description
`addresses`	`array`
`avatar_url`	`string`
`birthdate`	`date`
`check_in_count`	`integer`
`child`	`boolean`
`created_at`	`date_time`
`demographic_avatar_url`	`string`
`email_addresses`	`array`
`first_name`	`string`
`gender`	`string`
`grade`	`integer`
`headcounter`	`boolean`
`id`	`primary_key`
`ignore_filters`	`boolean`
`last_checked_in_at`	`date_time`
`last_name`	`string`
`medical_notes`	`string`
`middle_name`	`string`
`name`	`string`
`name_prefix`	`string`
`name_suffix`	`string`
`passed_background_check`	`boolean`
`permission`	`string`
`phone_numbers`	`array`
`top_permission`	`string`
`updated_at`	`date_time`

Can Include

Parameter	Value	Description	Assignable
include	organization	include associated organization

Order By

Parameter	Value	Type	Description
order	check_in_count	string	prefix with a hyphen (-check_in_count) to reverse the order
order	first_name	string	prefix with a hyphen (-first_name) to reverse the order
order	last_checked_in_at	string	prefix with a hyphen (-last_checked_in_at) to reverse the order
order	last_name	string	prefix with a hyphen (-last_name) to reverse the order

Query By

Name	Parameter	Type	Description	Example
headcounter	`where[headcounter]`	boolean	Query on a specific headcounter	`?where[headcounter]=true`
ignore_filters	`where[ignore_filters]`	boolean	Query on a specific ignore_filters	`?where[ignore_filters]=true`
permission	`where[permission]`	string	Query on a specific permission	`?where[permission]=string`
search_name	`where[search_name]`	string	Search by person name (first, last, combination)	`?where[search_name]=string`

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	`/check-ins/v2/people`

Reading

HTTP Method	Endpoint
GET	`/check-ins/v2/people/{id}`

Associations

HTTP Method	Endpoint	Returns	Filter By
GET	`https://api.planningcenteronline.com/check-ins/v2/people/{person_id}/check_ins`	CheckIn	`attendee` `checked_out` `first_time` `guest` `not_checked_out` `not_one_time_guest` `one_time_guest` `regular` `volunteer`
GET	`https://api.planningcenteronline.com/check-ins/v2/people/{person_id}/organization`	Organization
GET	`https://api.planningcenteronline.com/check-ins/v2/people/{person_id}/passes`	Pass
GET	`https://api.planningcenteronline.com/check-ins/v2/people/{person_id}/person_events`	PersonEvent

Belongs To

HTTP Method	Endpoint	Association
GET	`https://api.planningcenteronline.com/check-ins/v2/check_ins/{check_in_id}/checked_in_by`	CheckIn
GET	`https://api.planningcenteronline.com/check-ins/v2/check_ins/{check_in_id}/checked_out_by`	CheckIn
GET	`https://api.planningcenteronline.com/check-ins/v2/check_ins/{check_in_id}/person`	CheckIn
GET	`https://api.planningcenteronline.com/check-ins/v2/people`	Organization
GET	`https://api.planningcenteronline.com/check-ins/v2/passes/{pass_id}/person`	Pass
GET	`https://api.planningcenteronline.com/check-ins/v2/events/{event_id}/person_events/{person_event_id}/person`	PersonEvent