API
⌘K
My Developer Account

LocationEventPeriod

Counts check-ins for a location during a certain event period.

Example Request

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

View in API Explorer →

Example Object

{
  "type": "LocationEventPeriod",
  "id": "1",
  "attributes": {
    "created_at": "2000-01-01T12:00:00Z",
    "guest_count": 1,
    "regular_count": 1,
    "updated_at": "2000-01-01T12:00:00Z",
    "volunteer_count": 1
  },
  "relationships": {}
}

Attributes

Name Type Description
created_at date_time
guest_count integer
id primary_key
regular_count integer
updated_at date_time
volunteer_count integer

Can Include

Parameter Value Description Assignable
include event_period include associated event_period
include location include associated location

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/{event_period_id}/location_event_periods

Reading

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

Associations

HTTP Method Endpoint Returns Details Filter By
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 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}/location_event_periods/{location_event_period_id}/event_period EventPeriod
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}/location Location

Belongs To

HTTP Method Endpoint Association Details Filter By
GET https://api.planningcenteronline.com/check-ins/v2/check_ins/{check_in_id}/event_period/{event_period_id}/location_event_periods EventPeriod
GET https://api.planningcenteronline.com/check-ins/v2/check_ins/{check_in_id}/locations/{location_id}/location_event_periods Location