API
⌘K
My Developer Account

Tag

An organizational tag that can be applied to events.

Applied tags can be used to filter events on the calendar or filter events for reports, iCal feeds, kiosk, and the widget.

Example Request 

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

View in API Explorer →

Example Object 

{
  "type": "Tag",
  "id": "1",
  "attributes": {
    "church_center_category": true,
    "color": "string",
    "created_at": "2000-01-01T12:00:00Z",
    "name": "string",
    "position": 1.42,
    "updated_at": "2000-01-01T12:00:00Z"
  },
  "relationships": {}
}

Attributes

Name Type Description
church_center_category boolean

true indicates that this tag is used as a category on Church Center
color string

Hex color code of the tag
created_at date_time

UTC time at which the tag was created
id primary_key

Unique identifier for the tag
name string

The tag name
position float

If the tag belongs to a TagGroup, position indicates place in list within TagGroup in the UI.

If the tag does not belong to a TagGroup, position indicates place in list under "Individual Tags" in the UI.
updated_at date_time

UTC time at which the tag was updated

Can Include

Parameter Value Description Assignable
include tag_group

include associated tag_group

 create and update

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
church_center_category where[church_center_category] boolean

Query on a specific churchcentercategory

 ?where[church_center_category]=true
color where[color] string

Query on a specific color

 ?where[color]=string
created_at where[created_at] date_time

Query on a specific created_at

 ?where[created_at]=2000-01-01T12:00:00Z
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
position where[position] float

Query on a specific position

 ?where[position]=1.42
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/tags

Reading

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

Creating

HTTP Method Endpoint Assignable Attributes
POST /calendar/v2/tags
  • church_center_category
  • color
  • name
  • position

Updating

HTTP Method Endpoint Assignable Attributes
PATCH /calendar/v2/tags/{id}
  • church_center_category
  • color
  • name
  • position

Deleting

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

Associations

HTTP Method Endpoint Returns Details Filter By
GET https://api.planningcenteronline.com/calendar/v2/tags/{tag_id}/event_instances EventInstance
GET https://api.planningcenteronline.com/calendar/v2/tags/{tag_id}/events Event
GET https://api.planningcenteronline.com/calendar/v2/tags/{tag_id}/tag_group TagGroup

Belongs To

HTTP Method Endpoint Association Details Filter By
GET https://api.planningcenteronline.com/calendar/v2/event_instances/{event_instance_id}/tags EventInstance
GET https://api.planningcenteronline.com/calendar/v2/events/{event_id}/tags Event
GET https://api.planningcenteronline.com/calendar/v2/tags Organization
  • individual
GET https://api.planningcenteronline.com/calendar/v2/tag_groups/{tag_group_id}/tags TagGroup