EventPeriod

A recurrence of an event, sometimes called a "session". For weekly events, an event period is a week. For daily events, an event period is a day. An event period has event times, which is what people select when they actually check in. When new sessions are created, times are copied from one session to the next.

Example Request

curl https://api.planningcenteronline.com/check-ins/v2/check_ins/{check_in_id}/event_period

View in API Explorer →

Example Object

{
  "type": "EventPeriod",
  "id": "1",
  "attributes": {
    "created_at": "2000-01-01T12:00:00Z",
    "ends_at": "2000-01-01T12:00:00Z",
    "guest_count": 1,
    "note": "string",
    "regular_count": 1,
    "starts_at": "2000-01-01T12:00:00Z",
    "unique_guest_count": 1,
    "unique_regular_count": 1,
    "unique_total_count": 1,
    "unique_volunteer_count": 1,
    "updated_at": "2000-01-01T12:00:00Z",
    "volunteer_count": 1
  },
  "relationships": {
    "event": {
      "data": {
        "type": "Event",
        "id": "1"
      }
    }
  }
}

Attributes

Name	Type	Description
`created_at`	`date_time`
`ends_at`	`date_time`
`guest_count`	`integer`
`id`	`primary_key`
`note`	`string`
`regular_count`	`integer`
`starts_at`	`date_time`
`unique_guest_count`	`integer`	Deduplicated people with a Guest check-in. Only available when requested with the `?fields` param
`unique_regular_count`	`integer`	Deduplicated people with a Regular check-in. Only available when requested with the `?fields` param
`unique_total_count`	`integer`	Deduplicated people with any check-in. Only available when requested with the `?fields` param
`unique_volunteer_count`	`integer`	Deduplicated people with a Volunteer check-in. Only available when requested with the `?fields` param
`updated_at`	`date_time`
`volunteer_count`	`integer`

Relationships

Name	Type	Association Type	Note
event	Event	to_one

Can Include

Parameter	Value	Description	Assignable
include	event	include associated event	create and update
include	event_times	include associated event_times

Order By

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

Query By

Name	Parameter	Type	Description	Example
ends_at	`where[ends_at]`	date_time	Query on a specific ends_at	`?where[ends_at]=2000-01-01T12:00:00Z`
starts_at	`where[starts_at]`	date_time	Query on a specific starts_at	`?where[starts_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/{check_in_id}/event_period`

Reading

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

Associations

HTTP Method	Endpoint	Returns	Filter By
GET	`https://api.planningcenteronline.com/check-ins/v2/check_ins/{check_in_id}/event_period/{event_period_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/check_ins/{check_in_id}/event_period/{event_period_id}/event`	Event
GET	`https://api.planningcenteronline.com/check-ins/v2/check_ins/{check_in_id}/event_period/{event_period_id}/event_times`	EventTime	`available`
GET	`https://api.planningcenteronline.com/check-ins/v2/check_ins/{check_in_id}/event_period/{event_period_id}/location_event_periods`	LocationEventPeriod

Belongs To

HTTP Method	Endpoint	Association
GET	`https://api.planningcenteronline.com/check-ins/v2/check_ins/{check_in_id}/event_period`	CheckIn
GET	`https://api.planningcenteronline.com/check-ins/v2/stations/{station_id}/check_in_groups/{check_in_group_id}/event_period`	CheckInGroup
GET	`https://api.planningcenteronline.com/check-ins/v2/events/{event_id}/event_periods`	Event
GET	`https://api.planningcenteronline.com/check-ins/v2/event_times/{event_time_id}/event_period`	EventTime
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}/event_period`	LocationEventPeriod