CheckIn

An attendance record for an event.

If someone was checked out, checked_out_at will be present.

You can scope check-ins in a few ways:

regulars, guests, and volunteers correspond to the option selected when checking in.
attendees are regulars and guests together.
one_time_guests are check-ins which were created without a corresponding person record.
not_one_time_guests are check-ins which had a corresponding person record when they were created.
checked_out are check-ins where checked_out_at is present (meaning they were checked out from a station).
first_times are check-ins which are the person's first for a given event. (Label-only visitors are not included here.)

Example Request

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

View in API Explorer →

Example Object

{
  "type": "CheckIn",
  "id": "1",
  "attributes": {
    "checked_out_at": "2000-01-01T12:00:00Z",
    "confirmed_at": "2000-01-01T12:00:00Z",
    "created_at": "2000-01-01T12:00:00Z",
    "emergency_contact_name": "string",
    "emergency_contact_phone_number": "string",
    "first_name": "string",
    "kind": "string",
    "last_name": "string",
    "medical_notes": "string",
    "number": 1,
    "one_time_guest": true,
    "security_code": "string",
    "updated_at": "2000-01-01T12:00:00Z"
  },
  "relationships": {
    "event_period": {
      "data": {
        "type": "EventPeriod",
        "id": "1"
      }
    },
    "person": {
      "data": {
        "type": "Person",
        "id": "1"
      }
    }
  }
}

Attributes

Name	Type	Description
`checked_out_at`	`date_time`
`confirmed_at`	`date_time`
`created_at`	`date_time`
`emergency_contact_name`	`string`
`emergency_contact_phone_number`	`string`
`first_name`	`string`
`id`	`primary_key`
`kind`	`string`
`last_name`	`string`
`medical_notes`	`string`
`number`	`integer`
`one_time_guest`	`boolean`
`security_code`	`string`
`updated_at`	`date_time`

Relationships

Name	Type	Association Type	Note
event_period	EventPeriod	to_one
person	Person	to_one

Can Include

Parameter	Value	Description	Assignable
include	check_in_times	include associated checkintimes
include	checked_in_at	include associated checkedinat
include	checked_in_by	include associated checkedinby
include	checked_out_by	include associated checkedoutby
include	event	include associated event	create
include	event_period	include associated event_period	create and update
include	event_times	include associated event_times
include	locations	include associated locations
include	options	include associated options
include	person	include associated person	create and update

Order By

Parameter	Value	Type	Description
order	checked_out_at	string	prefix with a hyphen (-checkedoutat) to reverse the order
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	number	string	prefix with a hyphen (-number) 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
account_center_person_id	`where[account_center_person_id]`	integer	Query on a related person	`?where[account_center_person_id]=1`
created_at	`where[created_at]`	date_time	Query on a specific created_at	`?where[created_at]=2000-01-01T12:00:00Z`
security_code	`where[security_code]`	string	Query on a specific security_code	`?where[security_code]=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	`/check-ins/v2/check_ins`

Reading

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

Associations

HTTP Method	Endpoint	Returns
GET	`https://api.planningcenteronline.com/check-ins/v2/check_ins/{check_in_id}/check_in_group`	CheckInGroup
GET	`https://api.planningcenteronline.com/check-ins/v2/check_ins/{check_in_id}/check_in_times`	CheckInTime
GET	`https://api.planningcenteronline.com/check-ins/v2/check_ins/{check_in_id}/checked_in_at`	Station
GET	`https://api.planningcenteronline.com/check-ins/v2/check_ins/{check_in_id}/checked_in_by`	Person
GET	`https://api.planningcenteronline.com/check-ins/v2/check_ins/{check_in_id}/checked_out_by`	Person
GET	`https://api.planningcenteronline.com/check-ins/v2/check_ins/{check_in_id}/event`	Event
GET	`https://api.planningcenteronline.com/check-ins/v2/check_ins/{check_in_id}/event_period`	EventPeriod
GET	`https://api.planningcenteronline.com/check-ins/v2/check_ins/{check_in_id}/event_times`	EventTime
GET	`https://api.planningcenteronline.com/check-ins/v2/check_ins/{check_in_id}/locations`	Location
GET	`https://api.planningcenteronline.com/check-ins/v2/check_ins/{check_in_id}/options`	Option
GET	`https://api.planningcenteronline.com/check-ins/v2/check_ins/{check_in_id}/person`	Person

Belongs To

HTTP Method	Endpoint	Association	Filter By
GET	`https://api.planningcenteronline.com/check-ins/v2/stations/{station_id}/check_in_groups/{check_in_group_id}/check_ins`	CheckInGroup
GET	`https://api.planningcenteronline.com/check-ins/v2/events/{event_id}/check_ins`	Event	`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/check_ins/{check_in_id}/event_period/{event_period_id}/check_ins`	EventPeriod	`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/event_times/{event_time_id}/check_ins`	EventTime	`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/check_ins/{check_in_id}/locations/{location_id}/check_ins`	Location	`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/check_ins/{check_in_id}/event_period/{event_period_id}/location_event_periods/{location_event_period_id}/check_ins`	LocationEventPeriod	`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/event_times/{event_time_id}/location_event_times/{location_event_time_id}/check_ins`	LocationEventTime	`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/options/{option_id}/check_ins`	Option
GET	`https://api.planningcenteronline.com/check-ins/v2/check_ins`	Organization	`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}/check_ins`	Person	`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/events/{event_id}/person_events/{person_event_id}/first_check_in`	PersonEvent
GET	`https://api.planningcenteronline.com/check-ins/v2/events/{event_id}/person_events/{person_event_id}/last_check_in`	PersonEvent
GET	`https://api.planningcenteronline.com/check-ins/v2/stations/{station_id}/checked_in_at_check_ins`	Station	`attendee` `checked_out` `first_time` `guest` `not_checked_out` `not_one_time_guest` `one_time_guest` `regular` `volunteer`