Series

A Series can be specified for each plan to tie plans with similar messages together, even across Service Types.

Note: A series is not created until artwork is added from the plan. You can use series_title included in Plan attributes to get titles for series without artwork.

Example Request

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

View in API Explorer →

Example Object

{
  "type": "Series",
  "id": "1",
  "attributes": {
    "artwork_content_type": "string",
    "artwork_file_name": "string",
    "artwork_file_size": 1,
    "artwork_for_dashboard": "string",
    "artwork_for_mobile": "string",
    "artwork_for_plan": "string",
    "artwork_original": "string",
    "created_at": "2000-01-01T12:00:00Z",
    "has_artwork": true,
    "title": "string",
    "updated_at": "2000-01-01T12:00:00Z"
  },
  "relationships": {}
}

Attributes

Name	Type	Description
`artwork_content_type`	`string`
`artwork_file_name`	`string`
`artwork_file_size`	`integer`
`artwork_for_dashboard`	`string`
`artwork_for_mobile`	`string`
`artwork_for_plan`	`string`
`artwork_original`	`string`
`created_at`	`date_time`
`has_artwork`	`boolean`
`id`	`primary_key`
`title`	`string`
`updated_at`	`date_time`

Order By

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

Query By

Name	Parameter	Type	Description	Example
title	`where[title]`	string	Query on a specific title	`?where[title]=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	`/services/v2/series`

Reading

HTTP Method	Endpoint
GET	`/services/v2/series/{id}`

Associations

HTTP Method	Endpoint	Returns	Details	Filter By
GET	`https://api.planningcenteronline.com/services/v2/series/{series_id}/plans`	Plan

Belongs To

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