TagGroup

A way to group related tags. For example you could have a "Life Stage" tag group with tags like "Child", "Teen", "Adult", etc.

Example Request

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

View in API Explorer →

Example Object

{
  "type": "TagGroup",
  "id": "1",
  "attributes": {
    "display_publicly": true,
    "multiple_options_enabled": true,
    "name": "string",
    "position": 1
  },
  "relationships": {}
}

Attributes

Name	Type	Description
`display_publicly`	`boolean`	Whether or not this tag group is visible to the public on Church Center
`id`	`primary_key`
`multiple_options_enabled`	`boolean`	Whether or not a group can belong to many tags within this tag group
`name`	`string`	The name of the tag group
`position`	`integer`	The position of the tag group in relation to other tag groups

Order By

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

Query By

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

Reading

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

Associations

HTTP Method	Endpoint	Returns	Details	Filter By
GET	`https://api.planningcenteronline.com/groups/v2/tag_groups/{tag_group_id}/tags`	Tag	tags belonging to this tag group

Belongs To

HTTP Method	Endpoint	Association	Details	Filter By
GET	`https://api.planningcenteronline.com/groups/v2/tag_groups`	Organization	tag groups in this organization	`public`