Skip to content

List asset tags

GET
/v1/asset-tags
curl --request GET \
--url 'https://api.pixonaut.app/v1/asset-tags?page=1&pageSize=50' \
--header 'Authorization: Bearer <token>'

Operation ID: assetTags.list

Every tag the tenant’s assets carry, each with how many assets carry it, the most used first, then by name. With q, page or pageSize, a page of the tags that hold q, in the same order, and how many tags match.

page

The page to read, from 1; the first when left out.

integer
default: 1 >= 1 <= 100000

The page to read, from 1; the first when left out.

pageSize
integer
default: 50 >= 1 <= 200
q

Only the rows whose name holds this text, case aside. Naming q, page or pageSize answers a page with the total that match; naming none answers every row.

string
<= 200 characters

Only the rows whose name holds this text, case aside. Naming q, page or pageSize answers a page with the total that match; naming none answers every row.

A page of the tags, or every tag

Media typeapplication/json
Any of:
object
page
required
number
pageSize
required
number
tags
required
Array<object>
object
assetCount
required
number
tag
required
string
total
required
number

Examples

Exampleexample

Example

[
{
"assetCount": 12,
"tag": "summer"
},
{
"assetCount": 3,
"tag": "logo"
}
]
X-Request-Id
required
string

Every response names the request it answers in X-Request-Id: the id the request was sent with in that header, when it is well formed, else one the API gave it. Quote it when reporting a refusal or a failure: the API’s log lines for that request carry it.

Refused: unauthorized

Media typeapplication/json
object
error
required
string

Examples

Exampleunauthorized

unauthorized

{
"error": "unauthorized"
}
X-Request-Id
required
string

Every response names the request it answers in X-Request-Id: the id the request was sent with in that header, when it is well formed, else one the API gave it. Quote it when reporting a refusal or a failure: the API’s log lines for that request carry it.

Refused: origin_forbidden, forbidden, feature_disabled, workspace_suspended

Media typeapplication/json
object
error
required
string
feature

The feature the tenant does not have. Always sent with feature_disabled.

string

Examples

feature_disabled

{
"error": "feature_disabled",
"feature": "api"
}
X-Request-Id
required
string

Every response names the request it answers in X-Request-Id: the id the request was sent with in that header, when it is well formed, else one the API gave it. Quote it when reporting a refusal or a failure: the API’s log lines for that request carry it.

Refused: invalid_query

Media typeapplication/json
object
error
required
string

Examples

Exampleinvalid_query

invalid_query

{
"error": "invalid_query"
}
X-Request-Id
required
string

Every response names the request it answers in X-Request-Id: the id the request was sent with in that header, when it is well formed, else one the API gave it. Quote it when reporting a refusal or a failure: the API’s log lines for that request carry it.

Refused: db_error. A request that failed unexpectedly answers as text instead.

object
error
required
string

Examples

Exampledb_error

db_error

{
"error": "db_error"
}
X-Request-Id
required
string

Every response names the request it answers in X-Request-Id: the id the request was sent with in that header, when it is well formed, else one the API gave it. Quote it when reporting a refusal or a failure: the API’s log lines for that request carry it.

Questions? Write to [email protected].

Status · Terms of service · Privacy policy · Subprocessors