API
⌘K
My Developer Account

TagGroup

A grouping of tags for organizational purposes.

Example Request

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

View in API Explorer →

Example Object

{
  "type": "TagGroup",
  "id": "1",
  "attributes": {
    "created_at": "2000-01-01T12:00:00Z",
    "name": "string",
    "required": true,
    "updated_at": "2000-01-01T12:00:00Z"
  },
  "relationships": {}
}

Attributes

Name Type Description
created_at date_time UTC time at which the tag group was created
id primary_key Unique identifier for the tag group
name string The name of the tag group
required boolean - `true` indicates tag from this tag group must be applied when creating an event
updated_at date_time UTC time at which the tag group was updated

Can Include

Parameter Value Description Assignable
include events include associated events
include tags include associated tags

Order By

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

Query By

Name Parameter Type Description Example
created_at where[created_at] date_time Query on a specific created_at ?where[created_at]=2000-01-01T12:00:00Z
name where[name] string Query on a specific name ?where[name]=string
updated_at where[updated_at] date_time Query on a specific updated_at ?where[updated_at]=2000-01-01T12:00:00Z

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 /calendar/v2/tag_groups

Reading

HTTP Method Endpoint
GET /calendar/v2/tag_groups/{id}

Creating

HTTP Method Endpoint Assignable Attributes
POST /calendar/v2/tag_groups
  • name
  • required

Updating

HTTP Method Endpoint Assignable Attributes
PATCH /calendar/v2/tag_groups/{id}
  • name
  • required

Deleting

HTTP Method Endpoint
DELETE /calendar/v2/tag_groups/{id}

Associations

HTTP Method Endpoint Returns Details Filter By
GET https://api.planningcenteronline.com/calendar/v2/tag_groups/{tag_group_id}/events Event
GET https://api.planningcenteronline.com/calendar/v2/tag_groups/{tag_group_id}/tags Tag

Belongs To

HTTP Method Endpoint Association Details Filter By
GET https://api.planningcenteronline.com/calendar/v2/tag_groups Organization
  • required
GET https://api.planningcenteronline.com/calendar/v2/tags/{tag_id}/tag_group Tag