Event - Calendar API - Planning Center

Example Request

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

View in API Explorer →

Example Object

{
  "type": "Event",
  "id": "1",
  "attributes": {
    "approval_status": "string",
    "created_at": "2000-01-01T12:00:00Z",
    "description": "string",
    "featured": true,
    "image_url": "string",
    "name": "string",
    "percent_approved": 1,
    "percent_rejected": 1,
    "registration_url": "string",
    "summary": "string",
    "updated_at": "2000-01-01T12:00:00Z",
    "visible_in_church_center": true
  },
  "relationships": {
    "calendar": {
      "data": {
        "type": "Calendar",
        "id": "1"
      }
    },
    "owner": {
      "data": {
        "type": "Person",
        "id": "1"
      }
    }
  }
}

Attributes

Name	Type	Description
`approval_status`	`string`	Possible values: - `A`: approved. - `P`: pending. - `R`: rejected.
`created_at`	`date_time`	UTC time at which the event was created
`description`	`string`	A rich text public-facing summary of the event
`featured`	`boolean`	`true` indicates the event is featured on Church Center `false` indicates the event is not featured on Church Center
`id`	`primary_key`	Unique identifier for the event
`image_url`	`string`	Path to where the event image is stored
`name`	`string`	The name of the event
`percent_approved`	`integer`	Calculated by taking the sum of the `percent_approved` for all future `ReservationBlocks` and dividing that by the `count` of all future `ReservationBlocks`. If there are no future `ReservationBlocks`, returns `100`
`percent_rejected`	`integer`	Calculated by taking the sum of the `percent_rejected` for all future `ReservationBlocks` and dividing that by the `count` of all future `ReservationBlocks`. If there are no future `ReservationBlocks`, returns `0`
`registration_url`	`string`	The registration URL for the event
`summary`	`string`	A plain text public-facing summary of the event
`updated_at`	`date_time`	UTC time at which the event was updated
`visible_in_church_center`	`boolean`	`true` indicates the event Church Center visibility is set to 'Published' `false` indicates the event Church Center visibility is set to 'Hidden'

Relationships

Name	Type	Association Type	Note
calendar	Calendar	to_one
owner	Person	to_one

Can Include

Parameter	Value	Description	Assignable
include	attachments	include associated attachments
include	feed	include associated feed
include	owner	include associated owner	create and update
include	tags	include associated tags	create and update

Query By

Name	Parameter	Type	Description	Example
approval_status	`where[approval_status]`	string	Query on a specific approval_status	`?where[approval_status]=string`
created_at	`where[created_at]`	date_time	Query on a specific created_at	`?where[created_at]=2000-01-01T12:00:00Z`
featured	`where[featured]`	boolean	Query on a specific featured	`?where[featured]=true`
name	`where[name]`	string	Query on a specific name	`?where[name]=string`
percent_approved	`where[percent_approved]`	integer	Query on a specific percent_approved	`?where[percent_approved]=1`
percent_rejected	`where[percent_rejected]`	integer	Query on a specific percent_rejected	`?where[percent_rejected]=1`
updated_at	`where[updated_at]`	date_time	Query on a specific updated_at	`?where[updated_at]=2000-01-01T12:00:00Z`
visible_in_church_center	`where[visible_in_church_center]`	boolean	Query on a specific visibleinchurch_center	`?where[visible_in_church_center]=true`

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/events`

Reading

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

Associations

HTTP Method	Endpoint	Returns	Filter By
GET	`https://api.planningcenteronline.com/calendar/v2/events/{event_id}/attachments`	Attachment
GET	`https://api.planningcenteronline.com/calendar/v2/events/{event_id}/conflicts`	Conflict
GET	`https://api.planningcenteronline.com/calendar/v2/events/{event_id}/event_connections`	EventConnection
GET	`https://api.planningcenteronline.com/calendar/v2/events/{event_id}/event_instances`	EventInstance	`future`
GET	`https://api.planningcenteronline.com/calendar/v2/events/{event_id}/event_resource_requests`	EventResourceRequest
GET	`https://api.planningcenteronline.com/calendar/v2/events/{event_id}/feed`	Feed
GET	`https://api.planningcenteronline.com/calendar/v2/events/{event_id}/owner`	Person
GET	`https://api.planningcenteronline.com/calendar/v2/events/{event_id}/resource_bookings`	ResourceBooking	`future`
GET	`https://api.planningcenteronline.com/calendar/v2/events/{event_id}/tags`	Tag

Belongs To

HTTP Method	Endpoint	Association	Filter By
GET	`https://api.planningcenteronline.com/calendar/v2/attachments/{attachment_id}/event`	Attachment
GET	`https://api.planningcenteronline.com/calendar/v2/conflicts/{conflict_id}/winner`	Conflict
GET	`https://api.planningcenteronline.com/calendar/v2/event_instances/{event_instance_id}/event`	EventInstance
GET	`https://api.planningcenteronline.com/calendar/v2/event_resource_requests/{event_resource_request_id}/event`	EventResourceRequest
GET	`https://api.planningcenteronline.com/calendar/v2/event_instances/{event_instance_id}/event_times/{event_time_id}/event`	EventTime
GET	`https://api.planningcenteronline.com/calendar/v2/events`	Organization	`future`
GET	`https://api.planningcenteronline.com/calendar/v2/tags/{tag_id}/events`	Tag
GET	`https://api.planningcenteronline.com/calendar/v2/tag_groups/{tag_group_id}/events`	TagGroup