Skip to main content
GET
/
v0
/
tag-groups
/
{groupId}
/
tags
Retrieve tags for a tag group
curl --request GET \
  --url https://external.pleo.io/v0/tag-groups/{groupId}/tags \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "archived": false,
      "code": "12345",
      "createdAt": "2023-08-23T03:11:48Z",
      "groupId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "id": "c04c7e9e-6c15-11ee-b962-0242ac120002",
      "updatedAt": "2023-08-23T03:11:48Z",
      "name": "Lunch allowance"
    }
  ],
  "pagination": {
    "currentRequestPagination": {
      "parameters": {},
      "after": "<string>",
      "before": "<string>",
      "limit": 123,
      "offset": 123,
      "sortingKeys": [
        "<string>"
      ],
      "sortingOrder": []
    },
    "hasNextPage": true,
    "hasPreviousPage": true,
    "endCursor": "<string>",
    "startCursor": "<string>",
    "total": 123
  }
}

Authorizations

​
Authorization
string
header
required

JWT Bearer token authentication. Include the token in the Authorization header as: Bearer <token>

Path Parameters

​
groupId
string<uuid>
required

Unique identifier of the tag group.

Query Parameters

​
before
string

Lower bound of the page of data to return (cannot be used together with [after] or [offset]).

​
after
string

Upper bound of the page of data to return (cannot be used together with [before] or [offset]).

​
offset
integer<int64>

Offset of the page of data to return (cannot be used together with [before] or [after]).

​
limit
integer<int32>

The maximum amount of items to return.

​
sorting_keys
string[]

The keys to sort the results by.

​
sorting_order
enum<string>[]

The order to sort the results by. Must be the same length as [sortingKeys]; one order per key.

Available options:
ASC,
ASC_NULLS_FIRST,
ASC_NULLS_LAST,
DESC,
DESC_NULLS_FIRST,
DESC_NULLS_LAST
​
include_archived
boolean

Boolean flag to determine whether archived tags should be included.

Response

default - application/json;charset=UTF-8

default response

​
data
object[]
required
​
pagination
object
required