Feed - Calendar API - Planning Center

Example Request

curl https://api.planningcenteronline.com/calendar/v2/feeds

View in API Explorer →

Example Object

{
  "type": "Feed",
  "id": "1",
  "attributes": {
    "can_delete": true,
    "default_church_center_visibility": "value",
    "deleting": true,
    "feed_type": "value",
    "imported_at": "2000-01-01T12:00:00Z",
    "name": "string",
    "prefix_event_names": true,
    "source_id": "primary_key",
    "sync_campus_tags": true
  },
  "relationships": {
    "event_owner": {
      "data": {
        "type": "Person",
        "id": "1"
      }
    },
    "default_calendar": {
      "data": {
        "type": "Calendar",
        "id": "1"
      }
    }
  }
}

Attributes

Name	Type	Description
`can_delete`	`boolean`
`default_church_center_visibility`	`string`	Possible values: `hidden` or `published`
`deleting`	`boolean`
`feed_type`	`string`	Possible values: `registrations`, `groups`, `ical`, or `form`
`id`	`primary_key`
`imported_at`	`date_time`
`name`	`string`
`prefix_event_names`	`boolean`	Only available when requested with the `?fields` param
`source_id`	`primary_key`
`sync_campus_tags`	`boolean`	Only available when requested with the `?fields` param

Relationships

Name	Type	Association Type	Note
event_owner	Person	to_one
default_calendar	Calendar	to_one

Order By

Parameter	Value	Type	Description
order	name	string	prefix with a hyphen (-name) to reverse the order

Query By

Name	Parameter	Type	Description	Example
feed_type	`where[feed_type]`	string	Query on a specific feed_type Possible values: `registrations`, `groups`, `ical`, or `form`	`?where[feed_type]=value`
source_id	`where[source_id]`	primary_key	Query on a specific source_id	`?where[source_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	`/calendar/v2/feeds`

Reading

HTTP Method	Endpoint
GET	`/calendar/v2/feeds/{id}`

Belongs To

HTTP Method	Endpoint	Association	Details	Filter By
GET	`https://api.planningcenteronline.com/calendar/v2/events/{event_id}/feed`	Event
GET	`https://api.planningcenteronline.com/calendar/v2/feeds`	Organization