API
⌘K
My Developer Account

ServiceType

A Service Type is a container for plans.

Example Request 

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

View in API Explorer →

Example Object 

{
  "type": "ServiceType",
  "id": "1",
  "attributes": {
    "archived_at": "2000-01-01T12:00:00Z",
    "attachment_types_enabled": true,
    "background_check_permissions": "string",
    "comment_permissions": "string",
    "created_at": "2000-01-01T12:00:00Z",
    "custom_item_types": [],
    "deleted_at": "2000-01-01T12:00:00Z",
    "frequency": "string",
    "last_plan_from": "string",
    "name": "string",
    "permissions": "string",
    "scheduled_publish": true,
    "sequence": 1,
    "standard_item_types": [],
    "updated_at": "2000-01-01T12:00:00Z"
  },
  "relationships": {
    "parent": {
      "data": {
        "type": "Folder",
        "id": "1"
      }
    }
  }
}

Attributes

Name Type Description
archived_at date_time
attachment_types_enabled boolean
background_check_permissions string
comment_permissions string

DEPRECATED: this attribute will be removed in the next release and will return the string "DEPRECATED" in this version
created_at date_time
custom_item_types array

A array of hashes that maps an item title substring matcher to a color:

[{ name: "Announcements", color: "#FFFFFF" }]

Valid substring matchers are any string that could be used as an item title.

A color is the hexadecimal value of a valid color e.g. #FFFFFF Valid colors values are #e8f6df, #e0f7ff, #e6e2fd, #ffe0e8, #ffedd1, #cfcfcf, #eaebeb, and #ffffff
deleted_at date_time
frequency string
id primary_key
last_plan_from string
name string
permissions string
scheduled_publish boolean
sequence integer
standard_item_types array

An array of hashes that maps an item type to a color:

[{ name: "Header", color: "#FFFFFF" }]

Valid names are Header, Song, and Media.

A color is the hexadecimal value of a valid color e.g. #FFFFFF Valid colors values are #e8f6df, #e0f7ff, #e6e2fd, #ffe0e8, #ffedd1, #cfcfcf, #eaebeb, and #ffffff
updated_at date_time

Relationships

Name Type Association Type Note
parent Folder to_one

Can Include

Parameter Value Description Assignable
include time_preference_options

include associated timepreferenceoptions

Order By

Parameter Value Type Description
order name string

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

prefix with a hyphen (-sequence) 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
name where[name] string

Query on a specific name

 ?where[name]=string
parent_id where[parent_id] integer

Query on a related parent

 ?where[parent_id]=1

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

Reading

HTTP Method Endpoint
GET /services/v2/service_types/{id}

Creating

HTTP Method Endpoint Assignable Attributes
POST /services/v2/service_types
  • attachment_types_enabled
  • background_check_permissions
  • custom_item_types
  • frequency
  • last_plan_from
  • name
  • parent_id
  • scheduled_publish
  • sequence
  • standard_item_types

Updating

HTTP Method Endpoint Assignable Attributes
PATCH /services/v2/service_types/{id}
  • attachment_types_enabled
  • background_check_permissions
  • custom_item_types
  • frequency
  • last_plan_from
  • name
  • parent_id
  • scheduled_publish
  • sequence
  • standard_item_types

Deleting

HTTP Method Endpoint
DELETE /services/v2/service_types/{id}

Actions

HTTP Method Endpoint Description
POST https://api.planningcenteronline.com/services/v2/service_types/{service_type_id}/create_plans

Create multiple plans

Associations

HTTP Method Endpoint Returns Details Filter By
GET https://api.planningcenteronline.com/services/v2/service_types/{service_type_id}/attachments Attachment
GET https://api.planningcenteronline.com/services/v2/service_types/{service_type_id}/item_note_categories ItemNoteCategory
GET https://api.planningcenteronline.com/services/v2/service_types/{service_type_id}/live_controllers LiveController
GET https://api.planningcenteronline.com/services/v2/service_types/{service_type_id}/plan_note_categories PlanNoteCategory
GET https://api.planningcenteronline.com/services/v2/service_types/{service_type_id}/plan_person_times PlanPersonTime
GET https://api.planningcenteronline.com/services/v2/service_types/{service_type_id}/plan_templates PlanTemplate
GET https://api.planningcenteronline.com/services/v2/service_types/{service_type_id}/plan_times PlanTime
  • future
  • named
  • not_deleted
  • past
GET https://api.planningcenteronline.com/services/v2/service_types/{service_type_id}/plans Plan
  • after

    filter to plans with a time beginning after the after parameter

  • before

    filter to plans with a time beginning before the before parameter

  • future
  • no_dates
  • past
GET https://api.planningcenteronline.com/services/v2/service_types/{service_type_id}/public_view PublicView
GET https://api.planningcenteronline.com/services/v2/service_types/{service_type_id}/team_positions TeamPosition
GET https://api.planningcenteronline.com/services/v2/service_types/{service_type_id}/teams Team
GET https://api.planningcenteronline.com/services/v2/service_types/{service_type_id}/time_preference_options TimePreferenceOption
GET https://api.planningcenteronline.com/services/v2/service_types/{service_type_id}/unscoped_plans Plan
  • deleted

Belongs To

HTTP Method Endpoint Association Details Filter By
GET https://api.planningcenteronline.com/services/v2/folders/{folder_id}/service_types Folder
GET https://api.planningcenteronline.com/services/v2/series/{series_id}/plans/{plan_id}/live/{live_id}/service_type Live
GET https://api.planningcenteronline.com/services/v2/service_types Organization
  • no_parent
GET https://api.planningcenteronline.com/services/v2/teams/{team_id}/service_types Team