Live - Services API - Planning Center

Example Request

curl https://api.planningcenteronline.com/services/v2/series/{series_id}/plans/{plan_id}/live

View in API Explorer →

Example Object

{
  "type": "Live",
  "id": "1",
  "attributes": {
    "can_chat": true,
    "can_control": true,
    "can_control_video_feed": true,
    "can_take_control": true,
    "chat_room_channel": "string",
    "dates": "string",
    "live_channel": "string",
    "series_title": "string",
    "title": "string"
  },
  "relationships": {}
}

Attributes

Name	Type	Description
`can_chat`	`boolean`
`can_control`	`boolean`
`can_control_video_feed`	`boolean`
`can_take_control`	`boolean`
`chat_room_channel`	`string`
`dates`	`string`
`id`	`primary_key`
`live_channel`	`string`
`series_title`	`string`
`title`	`string`

Can Include

Parameter	Value	Description
include	controller	include associated controller
include	current_item_time	include associated current_item_time
include	items	include associated items
include	next_item_time	include associated next_item_time
include	service_type	include associated service_type

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	`/services/v2/series/{series_id}/plans/{plan_id}/live`

Reading

HTTP Method	Endpoint
GET	`/services/v2/series/{series_id}/plans/{plan_id}/live/{id}`

Creating

HTTP Method	Endpoint
POST	`/services/v2/series/{series_id}/plans/{plan_id}/live`

Updating

HTTP Method	Endpoint
PATCH	`/services/v2/series/{series_id}/plans/{plan_id}/live/{id}`

Deleting

HTTP Method	Endpoint
DELETE	`/services/v2/series/{series_id}/plans/{plan_id}/live/{id}`

Actions

HTTP Method	Endpoint	Description
POST	`https://api.planningcenteronline.com/services/v2/series/{series_id}/plans/{plan_id}/live/{live_id}/go_to_next_item`
POST	`https://api.planningcenteronline.com/services/v2/series/{series_id}/plans/{plan_id}/live/{live_id}/go_to_previous_item`
POST	`https://api.planningcenteronline.com/services/v2/series/{series_id}/plans/{plan_id}/live/{live_id}/toggle_control`

Associations

HTTP Method	Endpoint	Returns
GET	`https://api.planningcenteronline.com/services/v2/series/{series_id}/plans/{plan_id}/live/{live_id}/controller`	Person
GET	`https://api.planningcenteronline.com/services/v2/series/{series_id}/plans/{plan_id}/live/{live_id}/current_item_time`	ItemTime
GET	`https://api.planningcenteronline.com/services/v2/series/{series_id}/plans/{plan_id}/live/{live_id}/items`	Item
GET	`https://api.planningcenteronline.com/services/v2/series/{series_id}/plans/{plan_id}/live/{live_id}/next_item_time`	ItemTime
GET	`https://api.planningcenteronline.com/services/v2/series/{series_id}/plans/{plan_id}/live/{live_id}/service_type`	ServiceType
GET	`https://api.planningcenteronline.com/services/v2/series/{series_id}/plans/{plan_id}/live/{live_id}/watchable_plans`	Plan

Belongs To

HTTP Method	Endpoint	Association	Details	Filter By
GET	`https://api.planningcenteronline.com/services/v2/service_types/{service_type_id}/plans/{plan_id}/live`	Plan