Media - Services API - Planning Center

Example Request

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

View in API Explorer →

Example Object

{
  "type": "Media",
  "id": "1",
  "attributes": {
    "created_at": "2000-01-01T12:00:00Z",
    "creator_name": "string",
    "image_url": "string",
    "length": 1,
    "media_type": "string",
    "media_type_name": "string",
    "preview_content_type": "string",
    "preview_file_name": "string",
    "preview_file_size": 1,
    "preview_updated_at": "2000-01-01T12:00:00Z",
    "preview_url": "string",
    "themes": "string",
    "thumbnail_content_type": "string",
    "thumbnail_file_name": "string",
    "thumbnail_file_size": 1,
    "thumbnail_updated_at": "2000-01-01T12:00:00Z",
    "thumbnail_url": "string",
    "title": "string",
    "updated_at": "2000-01-01T12:00:00Z"
  },
  "relationships": {}
}

Attributes

Name	Type	Description
`created_at`	`date_time`
`creator_name`	`string`
`id`	`primary_key`
`image_url`	`string`
`length`	`integer`
`media_type`	`string`	Possible Values: `audio` `background_audio` `background_image` `background_video` `countdown` `curriculum` `document` `drama` `image` `powerpoint` `song_video` `video`
`media_type_name`	`string`
`preview_content_type`	`string`
`preview_file_name`	`string`
`preview_file_size`	`integer`
`preview_updated_at`	`date_time`
`preview_url`	`string`
`themes`	`string`
`thumbnail_content_type`	`string`
`thumbnail_file_name`	`string`
`thumbnail_file_size`	`integer`
`thumbnail_updated_at`	`date_time`
`thumbnail_url`	`string`
`title`	`string`
`updated_at`	`date_time`

Can Include

Parameter	Value	Description	Assignable
include	attachments	include associated attachments

Order By

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

Query By

Name	Parameter	Type	Description	Example
creator_name	`where[creator_name]`	string	Query on a specific creator_name	`?where[creator_name]=string`
id	`where[id]`	primary_key	Query on a specific id	`?where[id]=primary_key`
themes	`where[themes]`	string	Query on a specific themes	`?where[themes]=string`
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/media`

Reading

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

Creating

HTTP Method	Endpoint	Assignable Attributes
POST	`/services/v2/media`	media_type title creator_name themes

Updating

HTTP Method	Endpoint	Assignable Attributes
PATCH	`/services/v2/media/{id}`	media_type title creator_name themes

Deleting

HTTP Method	Endpoint
DELETE	`/services/v2/media/{id}`

Actions

HTTP Method	Endpoint	Description
POST	`https://api.planningcenteronline.com/services/v2/media/{media_id}/archive`	Archive a Media.
POST	`https://api.planningcenteronline.com/services/v2/media/{media_id}/assign_tags`	Used to assign tags to a media.
POST	`https://api.planningcenteronline.com/services/v2/media/{media_id}/unarchive`	Restore an archived Media.

Associations

HTTP Method	Endpoint	Returns
GET	`https://api.planningcenteronline.com/services/v2/media/{media_id}/attachments`	Attachment
GET	`https://api.planningcenteronline.com/services/v2/media/{media_id}/media_schedules`	MediaSchedule
GET	`https://api.planningcenteronline.com/services/v2/media/{media_id}/tags`	Tag

Belongs To

HTTP Method	Endpoint	Association	Details	Filter By
GET	`https://api.planningcenteronline.com/services/v2/service_types/{service_type_id}/plans/{plan_id}/items/{item_id}/media`	Item
GET	`https://api.planningcenteronline.com/services/v2/media`	Organization		`archived` `audio` `background_audio` `background_image` `background_video` `countdown` `curriculum` `document` `drama` `image` `not_archived` `powerpoint` `song_video` `video`