EventTime Collection Only

Start and end times for each event instance.

In the Calendar UI, these are represented under the "Schedule" section and may include "Setup" and "Teardown" times for the instance.

Example Request

curl https://api.planningcenteronline.com/calendar/v2/event_instances/{event_instance_id}/event_times

View in API Explorer →

Example Object

{
  "type": "EventTime",
  "id": "1",
  "attributes": {
    "ends_at": "2000-01-01T12:00:00Z",
    "name": "2000-01-01T12:00:00Z",
    "starts_at": "2000-01-01T12:00:00Z",
    "visible_on_kiosks": true,
    "visible_on_widget_and_ical": true
  },
  "relationships": {
    "event": {
      "data": {
        "type": "Event",
        "id": "1"
      }
    }
  }
}

Attributes

Name	Type	Description
`ends_at`	`date_time`	UTC time at which the event time ends
`id`	`primary_key`	Unique identifier for the event time
`name`	`date_time`	Name of the event time
`starts_at`	`date_time`	UTC time at which the event time starts
`visible_on_kiosks`	`boolean`	Set to `true` if the time is visible on kiosk
`visible_on_widget_and_ical`	`boolean`	Set to `true` if the time is visible on widget or iCal

Relationships

Name	Type	Association Type	Note
event	Event	to_one

Can Include

Parameter	Value	Description	Assignable
include	event	include associated event	create and update

Order By

Parameter	Value	Type	Description
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

Query By

Name	Parameter	Type	Description	Example
ends_at	`where[ends_at]`	date_time	Query on a specific ends_at	`?where[ends_at]=2000-01-01T12:00:00Z`
name	`where[name]`	date_time	Query on a specific name	`?where[name]=2000-01-01T12:00:00Z`
starts_at	`where[starts_at]`	date_time	Query on a specific starts_at	`?where[starts_at]=2000-01-01T12:00:00Z`
visible_on_kiosks	`where[visible_on_kiosks]`	boolean	Query on a specific visible_on_kiosks	`?where[visible_on_kiosks]=true`
visible_on_widget_and_ical	`where[visible_on_widget_and_ical]`	boolean	Query on a specific visible_on_widget_and_ical	`?where[visible_on_widget_and_ical]=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/event_instances/{event_instance_id}/event_times`

Associations

HTTP Method	Endpoint	Returns	Details	Filter By
GET	`https://api.planningcenteronline.com/calendar/v2/event_instances/{event_instance_id}/event_times/{event_time_id}/event`	Event

Belongs To

HTTP Method	Endpoint	Association	Details	Filter By
GET	`https://api.planningcenteronline.com/calendar/v2/event_instances/{event_instance_id}/event_times`	EventInstance