Label
Labels can be set to print for events (through EventLabels),
locations (through LocationLabels) or options.
Label type (security label / name label) is expressed with the
prints_for attribute. prints_for="Person" is a name label,
prints_for="Group" is a security label.
Example Object
{
"type": "Label",
"id": "1",
"attributes": {
"created_at": "2000-01-01T12:00:00Z",
"name": "string",
"prints_for": "string",
"roll": "string",
"updated_at": "2000-01-01T12:00:00Z",
"xml": "string"
},
"relationships": {}
}
Attributes
| Name |
Type |
Description |
created_at |
date_time |
|
id |
primary_key |
|
name |
string |
|
prints_for |
string |
|
roll |
string |
|
updated_at |
date_time |
|
xml |
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/labels |
Reading
| HTTP Method |
Endpoint |
| GET |
/check-ins/v2/labels/{id} |
Associations
| HTTP Method |
Endpoint |
Returns |
Details |
Filter By |
| GET |
https://api.planningcenteronline.com/check-ins/v2/labels/{label_id}/event_labels |
EventLabel
|
|
|
| GET |
https://api.planningcenteronline.com/check-ins/v2/labels/{label_id}/location_labels |
LocationLabel
|
|
|
Belongs To
| HTTP Method |
Endpoint |
Association |
Details |
Filter By |
| GET |
https://api.planningcenteronline.com/check-ins/v2/events/{event_id}/event_labels/{event_label_id}/label |
EventLabel
|
|
|
| GET |
https://api.planningcenteronline.com/check-ins/v2/labels/{label_id}/location_labels/{location_label_id}/label |
LocationLabel
|
|
|
| GET |
https://api.planningcenteronline.com/check-ins/v2/options/{option_id}/label |
Option
|
|
|
| GET |
https://api.planningcenteronline.com/check-ins/v2/labels |
Organization
|
|
|