PlatformNotification
A Platform Notification is a suite-wide notification that shows at the top of each application's screen until dismissed by the user.
Example Request
curl https://api.planningcenteronline.com/people/v2/people/{person_id}/platform_notifications
View in API Explorer →
Example Object
{
"type": "PlatformNotification",
"id": "1",
"attributes": {
"html": "string"
},
"relationships": {}
}
Attributes
| Name |
Type |
Description |
html |
string |
|
id |
primary_key |
|
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 |
/people/v2/people/{person_id}/platform_notifications |
Reading
| HTTP Method |
Endpoint |
| GET |
/people/v2/people/{person_id}/platform_notifications/{id} |
Belongs To
| HTTP Method |
Endpoint |
Association |
Details |
Filter By |
| GET |
https://api.planningcenteronline.com/people/v2/people/{person_id}/platform_notifications |
Person
|
|
|