Event - Check-Ins API - Planning Center

Example Request

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

View in API Explorer →

Example Object

{
  "type": "Event",
  "id": "1",
  "attributes": {
    "app_source": "string",
    "archived_at": "2000-01-01T12:00:00Z",
    "created_at": "2000-01-01T12:00:00Z",
    "enable_services_integration": true,
    "frequency": "string",
    "integration_key": "string",
    "location_times_enabled": true,
    "name": "string",
    "pre_select_enabled": true,
    "updated_at": "2000-01-01T12:00:00Z"
  },
  "relationships": {
    "campuses": {
      "data": [
        {
          "type": "Campus",
          "id": "1"
        }
      ]
    }
  }
}

Attributes

Name	Type	Description
`app_source`	`string`	Only available when requested with the `?fields` param
`archived_at`	`date_time`
`created_at`	`date_time`
`enable_services_integration`	`boolean`
`frequency`	`string`
`id`	`primary_key`
`integration_key`	`string`
`location_times_enabled`	`boolean`
`name`	`string`
`pre_select_enabled`	`boolean`
`updated_at`	`date_time`

Relationships

Name	Type	Association Type	Note
campuses	Campus	to_many

Can Include

Parameter	Value	Description	Assignable
include	attendance_types	include associated attendance_types

Order By

Parameter	Value	Type	Description
order	created_at	string	prefix with a hyphen (-created_at) to reverse the order
order	name	string	prefix with a hyphen (-name) to reverse the order

Query By

Name	Parameter	Type	Description	Example
id	`where[id]`	primary_key	Query on a specific id	`?where[id]=primary_key`
name	`where[name]`	string	Query on a specific name	`?where[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/events`

Reading

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

Associations

HTTP Method	Endpoint	Returns	Filter By
GET	`https://api.planningcenteronline.com/check-ins/v2/events/{event_id}/attendance_types`	AttendanceType
GET	`https://api.planningcenteronline.com/check-ins/v2/events/{event_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/events/{event_id}/current_event_times`	EventTime
GET	`https://api.planningcenteronline.com/check-ins/v2/events/{event_id}/event_labels`	EventLabel
GET	`https://api.planningcenteronline.com/check-ins/v2/events/{event_id}/event_periods`	EventPeriod
GET	`https://api.planningcenteronline.com/check-ins/v2/events/{event_id}/integration_links`	IntegrationLink
GET	`https://api.planningcenteronline.com/check-ins/v2/events/{event_id}/locations`	Location	`locations` `root`
GET	`https://api.planningcenteronline.com/check-ins/v2/events/{event_id}/person_events`	PersonEvent

Belongs To

HTTP Method	Endpoint	Association	Filter By
GET	`https://api.planningcenteronline.com/check-ins/v2/events/{event_id}/attendance_types/{attendance_type_id}/event`	AttendanceType
GET	`https://api.planningcenteronline.com/check-ins/v2/check_ins/{check_in_id}/event`	CheckIn
GET	`https://api.planningcenteronline.com/check-ins/v2/events/{event_id}/event_labels/{event_label_id}/event`	EventLabel
GET	`https://api.planningcenteronline.com/check-ins/v2/check_ins/{check_in_id}/event_period/{event_period_id}/event`	EventPeriod
GET	`https://api.planningcenteronline.com/check-ins/v2/event_times/{event_time_id}/event`	EventTime
GET	`https://api.planningcenteronline.com/check-ins/v2/check_ins/{check_in_id}/locations/{location_id}/event`	Location
GET	`https://api.planningcenteronline.com/check-ins/v2/events`	Organization	`archived` `for_campus` `for_headcounts` `for_registrations` `not_archived`
GET	`https://api.planningcenteronline.com/check-ins/v2/events/{event_id}/person_events/{person_event_id}/event`	PersonEvent
GET	`https://api.planningcenteronline.com/check-ins/v2/stations/{station_id}/event`	Station