CheckInGroup
When one or more people check in, they're grouped in a CheckInGroup.
These check-ins all have the same "checked-in by" person.
Example Request
curl https://api.planningcenteronline.com/check-ins/v2/stations/{station_id}/check_in_groups
View in API Explorer →
Example Object
{
"type": "CheckInGroup",
"id": "1",
"attributes": {
"check_ins_count": 1,
"created_at": "2000-01-01T12:00:00Z",
"name_labels_count": 1,
"print_status": "string",
"security_labels_count": 1,
"updated_at": "2000-01-01T12:00:00Z"
},
"relationships": {}
}
Attributes
| Name |
Type |
Description |
check_ins_count |
integer |
|
created_at |
date_time |
|
id |
primary_key |
|
name_labels_count |
integer |
|
print_status |
string |
Possible values:
- `ready`: This group isn't printed or canceled yet
- `printed`: This group was successfully printed at a station
- `canceled`: This group was canceled at a station
- `skipped`: This group had no labels to print, so it was never printed.
|
security_labels_count |
integer |
|
updated_at |
date_time |
|
Can Include
| Parameter |
Value |
Description |
Assignable |
| include |
check_ins |
include associated check_ins |
|
| include |
event_period |
include associated event_period |
|
| include |
print_station |
include associated print_station |
|
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/stations/{station_id}/check_in_groups |
Reading
| HTTP Method |
Endpoint |
| GET |
/check-ins/v2/stations/{station_id}/check_in_groups/{id} |
Associations
| HTTP Method |
Endpoint |
Returns |
Details |
Filter By |
| GET |
https://api.planningcenteronline.com/check-ins/v2/stations/{station_id}/check_in_groups/{check_in_group_id}/check_ins |
CheckIn
|
|
|
| GET |
https://api.planningcenteronline.com/check-ins/v2/stations/{station_id}/check_in_groups/{check_in_group_id}/event_period |
EventPeriod
|
|
|
| GET |
https://api.planningcenteronline.com/check-ins/v2/stations/{station_id}/check_in_groups/{check_in_group_id}/print_station |
Station
|
|
|
Belongs To
| HTTP Method |
Endpoint |
Association |
Details |
Filter By |
| GET |
https://api.planningcenteronline.com/check-ins/v2/check_ins/{check_in_id}/check_in_group |
CheckIn
|
|
|
| GET |
https://api.planningcenteronline.com/check-ins/v2/stations/{station_id}/check_in_groups |
Station
|
|
canceledprintedreadyskipped
|