List All Tags

GET/v1/tags

Returns tags for the workspace, ordered by created_at descending.

Query Parameters

pageinteger

Example:1

per_pageinteger

Example:25

qstring

Search by tag name

Example:VIP

Responses

Body

success_codeenum: 200 | 201•Numeric success code matching the HTTP response status. required

Example:200

messagestring required

Example:OK

detailsobject required

dataarray[object] required

idstring•Tag ULID

namestring

colorstring or null

descriptionstring or null

metaobject required

current_pageinteger

Example:1

per_pageinteger

Example:25

totalinteger

Example:1

last_pageinteger

Example:1

linksobject

firststring or null

laststring or null

prevstring or null

nextstring or null

error_codeinteger•Numeric error code matching the HTTP response status. required

Example:400

messagestring required

detailsobject•Validation errors are returned as a field-to-messages map; other errors may use arbitrary keys. required

error_codeinteger•Numeric error code matching the HTTP response status. required

Example:400

messagestring required

detailsobject•Validation errors are returned as a field-to-messages map; other errors may use arbitrary keys. required

error_codeinteger•Numeric error code matching the HTTP response status. required

Example:400

messagestring required

detailsobject•Validation errors are returned as a field-to-messages map; other errors may use arbitrary keys. required

error_codeinteger•Numeric error code matching the HTTP response status. required

Example:400

messagestring required

detailsobject•Validation errors are returned as a field-to-messages map; other errors may use arbitrary keys. required

Request Sample:Shell / cURL

1
2
3
4

curl --request GET \
  --url "https://api-preprod.bevatelcloud.com/v1/tags?page=1&per_page=25&q=VIP" \
  --header "Authorization: Bearer <YOUR_API_KEY>" \
  --header "Content-Type: application/json"

Response Example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

{
  "success_code": 200,
  "message": "OK",
  "details": {},
  "data": [
    {
      "id": "string",
      "name": "string",
      "color": "string",
      "description": "string"
    }
  ],
  "meta": {
    "current_page": 1,
    "per_page": 25,
    "total": 1,
    "last_page": 1,
    "links": {
      "first": "string",
      "last": "string",
      "prev": "string",
      "next": "string"
    }
  }
}