API
⌘K
My Developer Account

Channel

A collection of sermons

Example Request 

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

View in API Explorer →

Example Object 

{
  "type": "Channel",
  "id": "1",
  "attributes": {
    "activate_episode_minutes_before": 1,
    "art": {},
    "can_enable_chat": true,
    "church_center_url": "string",
    "created_at": "2000-01-01T12:00:00Z",
    "default_video_duration": 1,
    "default_video_embed_code": "string",
    "default_video_url": "string",
    "description": "string",
    "enable_audio": true,
    "enable_on_demand_video": true,
    "enable_watch_live": true,
    "general_chat_enabled": true,
    "group_chat_enabled": true,
    "name": "string",
    "podcast_art": {},
    "podcast_feed_url": "string",
    "podcast_settings": {},
    "position": 1,
    "published": true,
    "sermon_notes_enabled": true,
    "services_service_type_remote_identifier": "string",
    "updated_at": "2000-01-01T12:00:00Z",
    "url": "string"
  },
  "relationships": {}
}

Attributes

Name Type Description
activate_episode_minutes_before integer

The activation time for an episode, expressed in minutes before its start
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.
can_enable_chat boolean
church_center_url string
created_at date_time
default_video_duration integer
default_video_embed_code string
default_video_url string
description string
enable_audio boolean
enable_on_demand_video boolean
enable_watch_live boolean
general_chat_enabled boolean
group_chat_enabled boolean
id primary_key
name string
podcast_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.
podcast_feed_url string
podcast_settings hash
position integer
published boolean
sermon_notes_enabled boolean
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)
updated_at date_time
url string

Can Include

Parameter Value Description Assignable
include channel_default_episode_resources

include associated channeldefaultepisode_resources

 create and update
include channel_default_times

include associated channeldefaulttimes

 create and update
include current_episode

include associated current_episode

Order By

Parameter Value Type Description
order name string

prefix with a hyphen (-name) to reverse the order
order position string

prefix with a hyphen (-position) 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/channels

Reading

HTTP Method Endpoint
GET /publishing/v2/channels/{id}

Creating

HTTP Method Endpoint Assignable Attributes
POST /publishing/v2/channels
  • art
  • podcast_art
  • podcast_settings
  • activate_episode_minutes_before
  • default_video_embed_code
  • description
  • url
  • default_video_duration
  • default_video_url
  • enable_audio
  • enable_on_demand_video
  • enable_watch_live
  • general_chat_enabled
  • group_chat_enabled
  • name
  • position
  • published
  • sermon_notes_enabled

Updating

HTTP Method Endpoint Assignable Attributes
PATCH /publishing/v2/channels/{id}
  • art
  • podcast_art
  • podcast_settings
  • activate_episode_minutes_before
  • default_video_embed_code
  • description
  • url
  • default_video_duration
  • default_video_url
  • enable_audio
  • enable_on_demand_video
  • enable_watch_live
  • general_chat_enabled
  • group_chat_enabled
  • name
  • position
  • published
  • sermon_notes_enabled

Deleting

HTTP Method Endpoint
DELETE /publishing/v2/channels/{id}

Associations

HTTP Method Endpoint Returns Details Filter By
GET https://api.planningcenteronline.com/publishing/v2/channels/{channel_id}/channel_default_episode_resources ChannelDefaultEpisodeResource
GET https://api.planningcenteronline.com/publishing/v2/channels/{channel_id}/channel_default_times ChannelDefaultTime
GET https://api.planningcenteronline.com/publishing/v2/channels/{channel_id}/current_episode Episode
GET https://api.planningcenteronline.com/publishing/v2/channels/{channel_id}/episodes Episode
  • connected_to_services
  • not_connected_to_services
  • not_published
  • published
  • published_to_library
GET https://api.planningcenteronline.com/publishing/v2/channels/{channel_id}/next_times ChannelNextTime
GET https://api.planningcenteronline.com/publishing/v2/channels/{channel_id}/series Series
GET https://api.planningcenteronline.com/publishing/v2/channels/{channel_id}/statistics EpisodeStatistics

Belongs To

HTTP Method Endpoint Association Details Filter By
GET https://api.planningcenteronline.com/publishing/v2/episodes/{episode_id}/channel Episode
GET https://api.planningcenteronline.com/publishing/v2/channels Organization
  • podcast_enabled
  • published
GET https://api.planningcenteronline.com/publishing/v2/series/{series_id}/channel Series