Episode - Publishing API - Planning Center

Example Request

curl https://api.planningcenteronline.com/publishing/v2/episodes

View in API Explorer →

Example Object

{
  "type": "Episode",
  "id": "1",
  "attributes": {
    "art": {},
    "church_center_url": "string",
    "created_at": "2000-01-01T12:00:00Z",
    "description": "string",
    "library_audio_url": "string",
    "library_streaming_service": "value",
    "library_video_embed_code": "string",
    "library_video_thumbnail_url": "string",
    "library_video_url": "string",
    "needs_library_audio_or_video_url": true,
    "needs_notes_template": true,
    "needs_video_url": true,
    "page_actions": [],
    "published_live_at": "2000-01-01T12:00:00Z",
    "published_to_library_at": "2000-01-01T12:00:00Z",
    "sermon_audio": {},
    "services_plan_remote_identifier": "string",
    "services_service_type_remote_identifier": "string",
    "stream_type": "value",
    "streaming_service": "value",
    "title": "string",
    "updated_at": "2000-01-01T12:00:00Z",
    "video_embed_code": "string",
    "video_thumbnail_url": "string",
    "video_url": "string"
  },
  "relationships": {
    "series": {
      "data": {
        "type": "Series",
        "id": "1"
      }
    }
  }
}

Attributes

Name	Type	Description
`art`	`hash`	An image file object. When setting, pass an upload UUID from the Uploads API (https://api.planningcenteronline.com/docs/overview/file-uploads) or a signed_identifier from an existing File.
`church_center_url`	`string`
`created_at`	`date_time`
`description`	`string`
`id`	`primary_key`
`library_audio_url`	`string`
`library_streaming_service`	`string`	Possible values: `vimeo`, `youtube`, `livestream_com`, `resi`, `facebook`, or `boxcast`
`library_video_embed_code`	`string`
`library_video_thumbnail_url`	`string`
`library_video_url`	`string`
`needs_library_audio_or_video_url`	`boolean`
`needs_notes_template`	`boolean`
`needs_video_url`	`boolean`
`page_actions`	`array`
`published_live_at`	`date_time`
`published_to_library_at`	`date_time`
`sermon_audio`	`hash`	An audio file object. When setting, pass an upload UUID from the Uploads API (https://api.planningcenteronline.com/docs/overview/file-uploads) or a signed_identifier from an existing File.
`services_plan_remote_identifier`	`string`	The id for the associated Services Plan (https://developer.planning.center/docs/#/apps/services/2018-08-01/vertices/plan)
`services_service_type_remote_identifier`	`string`	The id for the associated Services Service Type (https://developer.planning.center/docs/#/apps/services/2018-08-01/vertices/service_type)
`stream_type`	`string`	Possible values: `channel_default_livestream`, `livestream`, or `prerecorded`
`streaming_service`	`string`	Possible values: `vimeo`, `youtube`, `livestream_com`, `resi`, `facebook`, or `boxcast`
`title`	`string`
`updated_at`	`date_time`
`video_embed_code`	`string`
`video_thumbnail_url`	`string`
`video_url`	`string`

Relationships

Name	Type	Association Type	Note
series	Series	to_one

Can Include

Parameter	Value	Description	Assignable
include	channel	include associated channel	create and update
include	episode_resources	include associated episode_resources	create and update
include	episode_times	include associated episode_times	create and update
include	series	include associated series	create and update
include	speakerships	include associated speakerships	create and update

Order By

Parameter	Value	Type	Description
order	published_live_at	string	prefix with a hyphen (-published_live_at) to reverse the order
order	published_to_library_at	string	prefix with a hyphen (-published_to_library_at) to reverse the order
order	stream_type	string	prefix with a hyphen (-stream_type) to reverse the order
order	title	string	prefix with a hyphen (-title) to reverse the order

Query By

Name	Parameter	Type	Description	Example
series_id	`where[series_id]`	integer	Query on a related series	`?where[series_id]=1`
services_plan_remote_identifier	`where[services_plan_remote_identifier]`	string	Query on a specific services_plan_remote_identifier	`?where[services_plan_remote_identifier]=string`
services_service_type_remote_identifier	`where[services_service_type_remote_identifier]`	string	Query on a specific services_service_type_remote_identifier	`?where[services_service_type_remote_identifier]=string`

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`

Reading

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

Creating

HTTP Method	Endpoint	Assignable Attributes
POST	`/publishing/v2/episodes`	art series_id title description sermon_audio stream_type video_url published_to_library_at library_audio_url library_video_url

Updating

HTTP Method	Endpoint	Assignable Attributes
PATCH	`/publishing/v2/episodes/{id}`	art series_id title description sermon_audio stream_type video_url published_to_library_at library_audio_url library_video_url

Deleting

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

Associations

HTTP Method	Endpoint	Returns
GET	`https://api.planningcenteronline.com/publishing/v2/episodes/{episode_id}/channel`	Channel
GET	`https://api.planningcenteronline.com/publishing/v2/episodes/{episode_id}/episode_resources`	EpisodeResource
GET	`https://api.planningcenteronline.com/publishing/v2/episodes/{episode_id}/episode_times`	EpisodeTime
GET	`https://api.planningcenteronline.com/publishing/v2/episodes/{episode_id}/note_template`	NoteTemplate
GET	`https://api.planningcenteronline.com/publishing/v2/episodes/{episode_id}/series`	Series
GET	`https://api.planningcenteronline.com/publishing/v2/episodes/{episode_id}/speakerships`	Speakership

Belongs To

HTTP Method	Endpoint	Association	Filter By
GET	`https://api.planningcenteronline.com/publishing/v2/channels/{channel_id}/current_episode`	Channel
GET	`https://api.planningcenteronline.com/publishing/v2/channels/{channel_id}/episodes`	Channel	`connected_to_services` `not_connected_to_services` `not_published` `published` `published_to_library`
GET	`https://api.planningcenteronline.com/publishing/v2/episodes`	Organization	`connected_to_services` `not_connected_to_services` `not_published_live` `published_live` `published_on_church_center`