Pass
Enables quick lookup of a person via barcode reader.
Example Object
{
"type": "Pass",
"id": "1",
"attributes": {
"code": "string",
"created_at": "2000-01-01T12:00:00Z",
"kind": "string",
"updated_at": "2000-01-01T12:00:00Z"
},
"relationships": {}
}
Attributes
| Name |
Type |
Description |
code |
string |
|
created_at |
date_time |
|
id |
primary_key |
|
kind |
string |
Possible values: `barcode` or `pkpass`.
Using the `pkpass` value creates a mobile pass and sends an email to the associated person.
|
updated_at |
date_time |
|
Can Include
| Parameter |
Value |
Description |
Assignable |
| include |
person |
include associated person |
|
Query By
| Name |
Parameter |
Type |
Description |
Example |
| code |
where[code] |
string |
Query on a specific code |
?where[code]=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/passes |
Reading
| HTTP Method |
Endpoint |
| GET |
/check-ins/v2/passes/{id} |
Associations
| HTTP Method |
Endpoint |
Returns |
Details |
Filter By |
| GET |
https://api.planningcenteronline.com/check-ins/v2/passes/{pass_id}/person |
Person
|
|
|
Belongs To
| HTTP Method |
Endpoint |
Association |
Details |
Filter By |
| GET |
https://api.planningcenteronline.com/check-ins/v2/passes |
Organization
|
|
|
| GET |
https://api.planningcenteronline.com/check-ins/v2/people/{person_id}/passes |
Person
|
|
|