EpisodeTime - Publishing API

Example Request

curl https://api.planningcenteronline.com/publishing/v2/episodes/{episode_id}/episode_times

View in API Explorer →

Example Object

{
  "type": "EpisodeTime",
  "id": "1",
  "attributes": {
    "caveats": [],
    "current_state": "string",
    "current_timestamp": 1.42,
    "ends_at": "2000-01-01T12:00:00Z",
    "starts_at": "2000-01-01T12:00:00Z",
    "streaming_service": "string",
    "video_embed_code": "string",
    "video_url": "string"
  },
  "relationships": {}
}

Attributes

Name	Type	Description
`caveats`	`array`
`current_state`	`string`	Possible values: `upcoming`, `active`, `over`
`current_timestamp`	`float`
`ends_at`	`date_time`
`id`	`primary_key`
`starts_at`	`date_time`
`streaming_service`	`string`	Possible values: `vimeo`, `youtube`, `livestream_com`, `resi`, `facebook`, `boxcast`
`video_embed_code`	`string`
`video_url`	`string`

Order By

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

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/episodes/{episode_id}/episode_times`

Reading

HTTP Method	Endpoint
GET	`/publishing/v2/episodes/{episode_id}/episode_times/{id}`

Creating

HTTP Method	Endpoint	Assignable Attributes
POST	`/publishing/v2/episodes/{episode_id}/episode_times`	starts_at video_embed_code video_url

Updating

HTTP Method	Endpoint	Assignable Attributes
PATCH	`/publishing/v2/episodes/{episode_id}/episode_times/{id}`	starts_at video_embed_code video_url

Deleting

HTTP Method	Endpoint
DELETE	`/publishing/v2/episodes/{episode_id}/episode_times/{id}`

Belongs To

HTTP Method	Endpoint	Association	Details	Filter By
GET	`https://api.planningcenteronline.com/publishing/v2/episodes/{episode_id}/episode_times`	Episode