API
⌘K
My Developer Account

Series

Example Request 

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

View in API Explorer →

Example Object 

{
  "type": "Series",
  "id": "1",
  "attributes": {
    "art": {},
    "church_center_url": "string",
    "created_at": "2000-01-01T12:00:00Z",
    "description": "string",
    "ended_at": "2000-01-01T12:00:00Z",
    "episodes_count": 1,
    "published": true,
    "started_at": "2000-01-01T12:00:00Z",
    "title": "string",
    "updated_at": "2000-01-01T12:00:00Z"
  },
  "relationships": {}
}

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
ended_at date_time
episodes_count integer
id primary_key
published boolean
started_at date_time
title string
updated_at date_time

Can Include

Parameter Value Description Assignable
include channel

include associated channel

Order By

Parameter Value Type Description
order ended_at string

prefix with a hyphen (-ended_at) to reverse the order
order episodes_count string

prefix with a hyphen (-episodes_count) to reverse the order
order started_at string

prefix with a hyphen (-started_at) to reverse the order
order title string

prefix with a hyphen (-title) to reverse the order

Query By

Name Parameter Type Description Example
id where[id] primary_key

Query on a specific id

 ?where[id]=primary_key

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/series

Reading

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

Creating

HTTP Method Endpoint Assignable Attributes
POST /publishing/v2/series
  • art
  • description
  • published
  • title

Updating

HTTP Method Endpoint Assignable Attributes
PATCH /publishing/v2/series/{id}
  • art
  • description
  • published
  • title

Deleting

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

Associations

HTTP Method Endpoint Returns Details Filter By
GET https://api.planningcenteronline.com/publishing/v2/series/{series_id}/channel Channel

Belongs To

HTTP Method Endpoint Association Details Filter By
GET https://api.planningcenteronline.com/publishing/v2/channels/{channel_id}/series Channel
GET https://api.planningcenteronline.com/publishing/v2/episodes/{episode_id}/series Episode
GET https://api.planningcenteronline.com/publishing/v2/series Organization
  • not_published
  • published