TagGroup - Services API - Planning Center

Example Request

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

View in API Explorer →

Example Object

{
  "type": "TagGroup",
  "id": "1",
  "attributes": {
    "allow_multiple_selections": true,
    "name": "string",
    "required": true,
    "service_type_folder_name": "string",
    "tags_for": "string"
  },
  "relationships": {}
}

Attributes

Name	Type	Description
`allow_multiple_selections`	`boolean`
`id`	`primary_key`
`name`	`string`
`required`	`boolean`
`service_type_folder_name`	`string`
`tags_for`	`string`	Scopes a tag group to `person`, `song`, `arrangement`, `media`

Can Include

Parameter	Value	Description	Assignable
include	folder	include associated folder
include	tags	include associated tags

Query By

Name	Parameter	Type	Description	Example
name	`where[name]`	string	Query on a specific name	`?where[name]=string`
tags_for	`where[tags_for]`	string	Query on a specific tags_for	`?where[tags_for]=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/tag_groups`

Reading

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

Associations

HTTP Method	Endpoint	Returns	Details	Filter By
GET	`https://api.planningcenteronline.com/services/v2/tag_groups/{tag_group_id}/folder`	Folder
GET	`https://api.planningcenteronline.com/services/v2/tag_groups/{tag_group_id}/tags`	Tag

Belongs To

HTTP Method	Endpoint	Association	Details	Filter By
GET	`https://api.planningcenteronline.com/services/v2/tag_groups`	Organization		`arrangement` `media` `person` `song`