Skip to main content
POST
/
v0
/
aggregations
/
tags
Retrieve tags in aggregated format
curl --request POST \
  --url https://external.pleo.io/v0/aggregations/tags \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json;charset=UTF-8' \
  --data '
{
  "archived": true,
  "includeArchived": true,
  "tagGroupIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "tagIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "textSearch": "<string>"
}
'
{
  "data": [
    {
      "archived": false,
      "code": "12345",
      "companyId": "c04c7e9e-6c15-11ee-b962-0242ac120003",
      "createdAt": "2023-08-23T03:11:48Z",
      "dimensions": [
        {
          "code": "5524f270-6c21-11ee-b962-0242ac120002",
          "displayOrder": 1,
          "id": "c04c7e9e-6c15-11ee-b962-0242ac120002",
          "name": "Project",
          "value": "<string>",
          "visible": false
        }
      ],
      "group": {
        "code": "5524f270-6c21-11ee-b962-0242ac120002",
        "id": "c04c7e9e-6c15-11ee-b962-0242ac120002",
        "name": "c04c7e9e-6c15-11ee-b962-0242ac120003"
      },
      "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": [
        "ASC"
      ]
    },
    "hasNextPage": true,
    "hasPreviousPage": true,
    "endCursor": "<string>",
    "startCursor": "<string>",
    "total": 123
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
company_id
string<uuid>

Unique identifier of the company whose tags you are searching for.

​
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

Body

application/json;charset=UTF-8
​
archived
boolean

True if only archived tags should be returned, False if only non-archived tags should be returned. if provided, includeArchived flag will be ignored. If not provided or null, archived and non-archived tags will be returned depending on the includeArchived flag.

​
includeArchived
boolean

Boolean flag to determine whether archived tags should be included. If not provided, only non-archived tags will be returned.

​
tagGroupIds
string<uuid>[]

List of tag group IDs that you are searching for.

List of tag group IDs that you are searching for.

​
tagIds
string<uuid>[]

List of tag IDs that you are searching for.

List of tag IDs that you are searching for.

​
textSearch
string

Free text search for tags by name.

Response

default - application/json;charset=UTF-8

default response

​
data
object[]
required
​
pagination
object
required