Announcement
Example Request
curl https://api.planningcenteronline.com/publishing/v2/announcementsExample Object
{
"type": "Announcement",
"id": "1",
"attributes": {
"archived": true,
"attach_linked_resource_image_job_id": "string",
"church_center_url": "string",
"featured": true,
"hide_at": "2000-01-01T12:00:00Z",
"image": {},
"link": "string",
"link_resource_id": 1,
"link_type": "string",
"show_at": "2000-01-01T12:00:00Z",
"status": "string",
"summary": "string",
"title": "string"
},
"relationships": {}
}Attributes
| Name | Type | Description |
|---|---|---|
archived |
boolean |
|
attach_linked_resource_image_job_id |
string |
|
church_center_url |
string |
|
featured |
boolean |
|
hide_at |
date_time |
|
id |
primary_key |
|
image |
hash |
|
link |
string |
|
link_resource_id |
integer |
|
link_type |
string |
|
show_at |
date_time |
|
status |
string |
|
summary |
string |
|
title |
string |
Can Include
| Parameter | Value | Description | Assignable |
|---|---|---|---|
| include | announcements_announcement_categories | include associated announcementsannouncementcategories |
create and update |
| include | announcements_campuses | include associated announcements_campuses |
create and update |
Order By
| Parameter | Value | Type | Description |
|---|---|---|---|
| order | featured | string | prefix with a hyphen (-featured) to reverse the order |
| order | show_at | string | prefix with a hyphen (-show_at) to reverse the order |
| order | status | string | prefix with a hyphen (-status) to reverse the order |
| order | title | string | prefix with a hyphen (-title) to reverse the order |
Query By
| Name | Parameter | Type | Description | Example |
|---|---|---|---|---|
| title | where[title] |
string | Query on a specific title |
?where[title]=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 | /publishing/v2/announcements |
Reading
| HTTP Method | Endpoint |
|---|---|
| GET | /publishing/v2/announcements/{id} |
Associations
| HTTP Method | Endpoint | Returns | Details | Filter By |
|---|---|---|---|---|
| GET | https://api.planningcenteronline.com/publishing/v2/announcements/{announcement_id}/announcements_announcement_categories |
AnnouncementsAnnouncementCategory | ||
| GET | https://api.planningcenteronline.com/publishing/v2/announcements/{announcement_id}/announcements_campuses |
AnnouncementsCampus |
Belongs To
| HTTP Method | Endpoint | Association | Details | Filter By |
|---|---|---|---|---|
| GET | https://api.planningcenteronline.com/publishing/v2/announcements |
Organization |
|