/api/v1/accounts/{accountId}/tags (GET)

GET

/api/v1/accounts/{accountId}/tags

curl --request GET \
  --url 'https://example.com/api/v1/accounts/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/tags?limit=20'

Parameters

Path Parameters

accountId

required

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

Query Parameters

q

string

<= 200 characters

limit

integer

default: 20 >= 1 <= 200

cursor

string

<= 2048 characters

Responses

200

Default Response

Media typeapplication/json

object

items

required

Array<object>

object

id

required

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

rowVersion

required

integer

>= -9007199254740991 <= 9007199254740991

ownerAccountId

required

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

name

required

string

colour

required

string | null

next_cursor

required

string | null

Example^generated

{
  "items": [
    {
      "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "rowVersion": 1,
      "ownerAccountId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "name": "example",
      "colour": "example"
    }
  ],
  "next_cursor": "example"
}