Label
A Label is a way for Admins to manage and categorize Donations.
Multiple Labels can be added for each Donation, and these will only be displayed in the Giving admin interface, so donors never see them.
Example Object
{
"type": "Label",
"id": "1",
"attributes": {
"slug": "string"
},
"relationships": {}
}
Attributes
| Name |
Type |
Description |
id |
primary_key |
The unique identifier for a label. |
slug |
string |
The label text itself. Made up solely of lowercase letters, numbers, and dashes. When creating or updating a label, the string you provide will be formatted automatically. For example: `My awesome label!` will be saved as `my-awesome-label` |
Query By
| Name |
Parameter |
Type |
Description |
Example |
| slug |
where[slug] |
string |
Query on a specific slug |
?where[slug]=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 |
/giving/v2/labels |
Reading
| HTTP Method |
Endpoint |
| GET |
/giving/v2/labels/{id} |
Creating
| HTTP Method |
Endpoint |
Assignable Attributes |
| POST |
/giving/v2/labels |
|
Updating
| HTTP Method |
Endpoint |
Assignable Attributes |
| PATCH |
/giving/v2/labels/{id} |
|
Deleting
| HTTP Method |
Endpoint |
| DELETE |
/giving/v2/labels/{id} |
Belongs To
| HTTP Method |
Endpoint |
Association |
Details |
Filter By |
| GET |
https://api.planningcenteronline.com/giving/v2/donations/{donation_id}/labels |
Donation
|
|
|
| GET |
https://api.planningcenteronline.com/giving/v2/labels |
Organization
|
|
|