EventInstance - Calendar API

Example Request

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

View in API Explorer →

Example Object

{
  "type": "EventInstance",
  "id": "1",
  "attributes": {
    "all_day_event": true,
    "church_center_url": "string",
    "compact_recurrence_description": "string",
    "created_at": "2000-01-01T12:00:00Z",
    "description": "string",
    "ends_at": "2000-01-01T12:00:00Z",
    "image_url": "string",
    "kind": "string",
    "location": "string",
    "name": "string",
    "published_ends_at": "string",
    "published_starts_at": "string",
    "recurrence": "string",
    "recurrence_description": "string",
    "starts_at": "2000-01-01T12:00:00Z",
    "updated_at": "2000-01-01T12:00:00Z"
  },
  "relationships": {
    "event": {
      "data": {
        "type": "Event",
        "id": "1"
      }
    }
  }
}

Attributes

Name	Type	Description
`all_day_event`	`boolean`	Indicates whether event instance lasts all day
`church_center_url`	`string`	The URL for the event on Church Center
`compact_recurrence_description`	`string`	Compact representation of event instance's recurrence pattern
`created_at`	`date_time`	UTC time at which the event instance was created
`description`	`string`	A rich text public-facing summary of the event Only available when requested with the `?fields` param
`ends_at`	`date_time`	UTC time at which the event instance ends
`id`	`primary_key`	Unique identifier for the event instance
`image_url`	`string`	Path to where the event image is stored Only available when requested with the `?fields` param
`kind`	`string`	The type of event: `standard` or `blockout` Only available when requested with the `?fields` param
`location`	`string`	Representation of where the event instance takes place
`name`	`string`	Name of event. Can be overridden for specific instances
`published_ends_at`	`string`	Publicly visible end time
`published_starts_at`	`string`	Publicly visible start time
`recurrence`	`string`	For a recurring event instance, the interval of how often the event instance occurs
`recurrence_description`	`string`	Longer description of the event instance's recurrence pattern
`starts_at`	`date_time`	UTC time at which the event instance starts
`updated_at`	`date_time`	UTC time at which the event instance was updated

Relationships

Name	Type	Association Type	Note
event	Event	to_one

Can Include

Parameter	Value	Description	Assignable
include	event	include associated event	create and update
include	event_times	include associated event_times
include	resource_bookings	include associated resource_bookings
include	tags	include associated tags

Order By

Parameter	Value	Type	Description
order	created_at	string	prefix with a hyphen (-created_at) to reverse the order
order	ends_at	string	prefix with a hyphen (-ends_at) to reverse the order
order	starts_at	string	prefix with a hyphen (-starts_at) to reverse the order
order	updated_at	string	prefix with a hyphen (-updated_at) to reverse the order

Query By

Name	Parameter	Type	Description	Example
created_at	`where[created_at]`	date_time	Query on a specific created_at	`?where[created_at]=2000-01-01T12:00:00Z`
ends_at	`where[ends_at]`	date_time	Query on a specific ends_at	`?where[ends_at]=2000-01-01T12:00:00Z`
kind	`where[kind]`	string	Query on a specific kind	`?where[kind]=string`
starts_at	`where[starts_at]`	date_time	Query on a specific starts_at	`?where[starts_at]=2000-01-01T12:00:00Z`
updated_at	`where[updated_at]`	date_time	Query on a specific updated_at	`?where[updated_at]=2000-01-01T12:00:00Z`

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

Reading

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

Associations

HTTP Method	Endpoint	Returns	Filter By
GET	`https://api.planningcenteronline.com/calendar/v2/event_instances/{event_instance_id}/event`	Event
GET	`https://api.planningcenteronline.com/calendar/v2/event_instances/{event_instance_id}/event_times`	EventTime
GET	`https://api.planningcenteronline.com/calendar/v2/event_instances/{event_instance_id}/resource_bookings`	ResourceBooking	`future` `resources` `rooms`
GET	`https://api.planningcenteronline.com/calendar/v2/event_instances/{event_instance_id}/tags`	Tag

Belongs To

HTTP Method	Endpoint	Association	Filter By
GET	`https://api.planningcenteronline.com/calendar/v2/events/{event_id}/event_instances`	Event	`future`
GET	`https://api.planningcenteronline.com/calendar/v2/event_instances`	Organization	`all` filter to instances you approve, manage, own, or subscribe to; can't be combined with any other user scopes `approved` filter to instances that are approved; can't be combined with any other `approved` scopes `approved_pending` `approved_pending_rejected` `approved_rejected` `approver` filter to instances you approve; can't be combined with any other `approver` scopes `approver_subscriber` `future` `lost` `lost_due_to_blockout` `manager` filter to instances you manage; can't be combined with any other `manager` scopes `manager_approver` `manager_approver_subscriber` `manager_subscriber` `not_pending_event_requests` `owner` filter to instances you own; can't be combined with any other `owner` scopes `owner_approver` `owner_approver_subscriber` `owner_manager` `owner_manager_approver` `owner_manager_approver_subscriber` `owner_manager_subscriber` `owner_subscriber` `pending` filter to instances that are pending; can't be combined with any other `pending` scopes `pending_rejected` `rejected` filter to instances that are rejected; can't be combined with any other `rejected` scopes `shared` `subscriber` filter to instances you subscribe to; can't be combined with any other `subscriber` scopes `unresolved`
GET	`https://api.planningcenteronline.com/calendar/v2/resource_bookings/{resource_booking_id}/event_instance`	ResourceBooking
GET	`https://api.planningcenteronline.com/calendar/v2/tags/{tag_id}/event_instances`	Tag