PlanTemplate - Services API

Example Request

curl https://api.planningcenteronline.com/services/v2/service_types/{service_type_id}/plan_templates

View in API Explorer →

Example Object

{
  "type": "PlanTemplate",
  "id": "1",
  "attributes": {
    "can_view_order": true,
    "created_at": "2000-01-01T12:00:00Z",
    "item_count": 1,
    "multi_day": true,
    "name": "string",
    "note_count": 1,
    "prefers_order_view": true,
    "rehearsable": true,
    "team_count": 1,
    "updated_at": "2000-01-01T12:00:00Z"
  },
  "relationships": {
    "service_type": {
      "data": {
        "type": "ServiceType",
        "id": "1"
      }
    },
    "created_by": {
      "data": {
        "type": "Person",
        "id": "1"
      }
    },
    "updated_by": {
      "data": {
        "type": "Person",
        "id": "1"
      }
    }
  }
}

Attributes

Name	Type	Description
`can_view_order`	`boolean`
`created_at`	`date_time`
`id`	`primary_key`
`item_count`	`integer`
`multi_day`	`boolean`
`name`	`string`
`note_count`	`integer`
`prefers_order_view`	`boolean`
`rehearsable`	`boolean`
`team_count`	`integer`
`updated_at`	`date_time`

Relationships

Name	Type	Association Type
service_type	ServiceType	to_one
created_by	Person	to_one
updated_by	Person	to_one

Order By

Parameter	Value	Type	Description
order	created_at	string	prefix with a hyphen (-created_at) to reverse the order
order	item_count	string	prefix with a hyphen (-item_count) to reverse the order
order	name	string	prefix with a hyphen (-name) to reverse the order
order	note_count	string	prefix with a hyphen (-note_count) to reverse the order
order	team_count	string	prefix with a hyphen (-team_count) to reverse the order
order	updated_at	string	prefix with a hyphen (-updated_at) to reverse the order

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/{service_type_id}/plan_templates`

Reading

HTTP Method	Endpoint
GET	`/services/v2/service_types/{service_type_id}/plan_templates/{id}`

Actions

HTTP Method	Endpoint	Description
POST	`https://api.planningcenteronline.com/services/v2/service_types/{service_type_id}/plan_templates/{plan_template_id}/item_reorder`	Reorder plan template items in one request.

Associations

HTTP Method	Endpoint	Returns	Filter By
GET	`https://api.planningcenteronline.com/services/v2/service_types/{service_type_id}/plan_templates/{plan_template_id}/items`	Item
GET	`https://api.planningcenteronline.com/services/v2/service_types/{service_type_id}/plan_templates/{plan_template_id}/notes`	PlanNote
GET	`https://api.planningcenteronline.com/services/v2/service_types/{service_type_id}/plan_templates/{plan_template_id}/team_members`	PlanPerson	`confirmed` `not_archived` `not_declined` `not_deleted`

Belongs To

HTTP Method	Endpoint	Association	Details	Filter By
GET	`https://api.planningcenteronline.com/services/v2/service_types/{service_type_id}/plan_templates`	ServiceType