Skip to content

List the values the asset listing can filter on

GET
/v1/asset-filters
curl --request GET \
--url https://api.pixonaut.app/v1/asset-filters \
--header 'Authorization: Bearer <token>'

Operation ID: assetFilters.list

The sessions and templates assets were uploaded for, most recent first, and the categories and tags, by name. Each list is capped, so a large tenant’s is not complete.

The filter values

Media typeapplication/json
object
categories
required
Array<object>
object
id
required
string
name
required
string
sessions
required
Array<string>
tags
required
Array<string>
templates
required
Array<string>

Examples

Exampleexample

Example

{
"categories": [
{
"id": "5d8f2a41-9b3c-4d7e-8f1a-2b3c4d5e6f70",
"name": "Logos"
}
],
"sessions": [
"9e4b7c12-6a5d-4f38-b1c2-d3e4f5a6b7c8"
],
"tags": [
"logo",
"summer"
],
"templates": [
"tshirt-basic"
]
}
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: 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