Location

A place where people may check in to for a given event. Some locations have kind="Folder", which means that people can't check-in here, but this location contains other locations. You can get its contents from the locations attribute. You can get a location's parent folder from the parent attribute. (If it's not in a folder, parent will be empty.)

Example Request

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

View in API Explorer →

Example Object

{
  "type": "Location",
  "id": "1",
  "attributes": {
    "age_max_in_months": 1,
    "age_min_in_months": 1,
    "age_on": "2000-01-01",
    "age_range_by": "string",
    "attendees_per_volunteer": 1,
    "child_or_adult": "string",
    "created_at": "2000-01-01T12:00:00Z",
    "effective_date": "2000-01-01",
    "gender": "string",
    "grade_max": 1,
    "grade_min": 1,
    "kind": "string",
    "max_occupancy": 1,
    "milestone": "string",
    "min_volunteers": 1,
    "name": "string",
    "opened": true,
    "position": 1,
    "questions": "string",
    "updated_at": "2000-01-01T12:00:00Z"
  },
  "relationships": {
    "parent": {
      "data": {
        "type": "Parent",
        "id": "1"
      }
    }
  }
}

Attributes

Name	Type	Description
`age_max_in_months`	`integer`
`age_min_in_months`	`integer`
`age_on`	`date`
`age_range_by`	`string`
`attendees_per_volunteer`	`integer`
`child_or_adult`	`string`
`created_at`	`date_time`
`effective_date`	`date`
`gender`	`string`
`grade_max`	`integer`
`grade_min`	`integer`
`id`	`primary_key`
`kind`	`string`
`max_occupancy`	`integer`
`milestone`	`string`
`min_volunteers`	`integer`
`name`	`string`
`opened`	`boolean`
`position`	`integer`
`questions`	`string`
`updated_at`	`date_time`

Relationships

Name	Type	Association Type	Note
parent	Parent	to_one

Can Include

Parameter	Value	Description	Assignable
include	event	include associated event
include	locations	include associated locations
include	options	include associated options
include	parent	include associated parent	create and update

Order By

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

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}/locations`

Reading

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

Associations

HTTP Method	Endpoint	Returns	Filter By
GET	`https://api.planningcenteronline.com/check-ins/v2/check_ins/{check_in_id}/locations/{location_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}/locations/{location_id}/event`	Event
GET	`https://api.planningcenteronline.com/check-ins/v2/check_ins/{check_in_id}/locations/{location_id}/integration_links`	IntegrationLink
GET	`https://api.planningcenteronline.com/check-ins/v2/check_ins/{check_in_id}/locations/{location_id}/location_event_periods`	LocationEventPeriod
GET	`https://api.planningcenteronline.com/check-ins/v2/check_ins/{check_in_id}/locations/{location_id}/location_event_times`	LocationEventTime
GET	`https://api.planningcenteronline.com/check-ins/v2/check_ins/{check_in_id}/locations/{location_id}/location_labels`	LocationLabel
GET	`https://api.planningcenteronline.com/check-ins/v2/check_ins/{check_in_id}/locations/{location_id}/locations`	Location
GET	`https://api.planningcenteronline.com/check-ins/v2/check_ins/{check_in_id}/locations/{location_id}/options`	Option
GET	`https://api.planningcenteronline.com/check-ins/v2/check_ins/{check_in_id}/locations/{location_id}/parent`	Location

Belongs To

HTTP Method	Endpoint	Association	Filter By
GET	`https://api.planningcenteronline.com/check-ins/v2/check_ins/{check_in_id}/locations`	CheckIn
GET	`https://api.planningcenteronline.com/check-ins/v2/events/{event_id}/locations`	Event	`locations` `root`
GET	`https://api.planningcenteronline.com/check-ins/v2/event_times/{event_time_id}/available_locations`	EventTime	`for_current_station`
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`	LocationEventPeriod
GET	`https://api.planningcenteronline.com/check-ins/v2/event_times/{event_time_id}/location_event_times/{location_event_time_id}/location`	LocationEventTime
GET	`https://api.planningcenteronline.com/check-ins/v2/labels/{label_id}/location_labels/{location_label_id}/location`	LocationLabel
GET	`https://api.planningcenteronline.com/check-ins/v2/check_ins/{check_in_id}/locations/{location_id}/locations`	Location
GET	`https://api.planningcenteronline.com/check-ins/v2/check_ins/{check_in_id}/locations/{location_id}/parent`	Location
GET	`https://api.planningcenteronline.com/check-ins/v2/stations/{station_id}/location`	Station