Skip to main content
GET
/
tag-groups
Get all tag groups belonging to the specified company.
curl --request GET \
  --url https://openapi.pleo.io/v1/tag-groups \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "0f0e000-000d-0d00-000b-00db0d000fae",
    "name": "<string>",
    "tagAttributes": [
      {
        "id": "0f0e000-000d-0d00-000b-00db0d000fae",
        "name": "<string>",
        "displayOrder": 123,
        "hidden": true
      }
    ],
    "archived": true
  }
]

Authorizations

​
Authorization
string
header
required

Open API Bearer token

Query Parameters

​
archived
boolean

This flag allows you fetch only tag groups that have been archived if set to true or those that are still actively in use if set to false. By default it will only fetch active tag groups.

Response

Tag groups have been returned

​
id
string
required

This is the internal pleo identifier of the tag group

Example:

"0f0e000-000d-0d00-000b-00db0d000fae"

​
name
string
required

This is the tag group name supplied on create

​
tagAttributes
object[]
required

These are the attributes that define a tag in this tag group, i.e. the tag columns. Each tag column is included only once.

​
archived
boolean
required

This flag specifies whether the tag group has been archived in the Pleo system or not