Skip to main content
GET
List Assets

Authorizations

Authorization
string
header
required

Bearer token

Headers

X-Account-ID
string<uuid>
required

Account ID

Path Parameters

assetTypeName
string
required

Asset type name

Query Parameters

group_by
enum<string>

Return paginated organization groups with matching asset counts; groups are ordered by organization name.

Available options:
organization_id
organization_id
string

Filter by organization; comma-separated for multiple

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}(,[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})*$
name
string

Filter by asset name

Full-text search query

include_deleted
boolean

Include soft-deleted assets in results (default: false)

expand
string

Comma-separated list of fields to expand (e.g., "tags", "references", "references.referenceName")

tags
string

Comma-separated tag ids; returns assets carrying ANY of these tags.

include_descendant_tags
boolean

When true, tags also matches assets carrying any tag beneath the given tags

group_tag
string<uuid>

Tag group membership, intersected with the tags filter

group_tag_descendants
boolean

Include descendants when matching group_tag

untagged
boolean

When true, returns only assets with no tags

tag_parent_not
string

Tag id — returns only assets that carry neither this tag nor any tag beneath it

fields
string

Comma-separated list of fields to return, or "*" for all fields. Default excludes richtext fields for performance.

sort
string

Field name to sort by

order
enum<string>

Sort order

Available options:
ASC,
DESC
limit
number
default:100
Required range: 1 <= x <= 1000
offset
number
default:0
Required range: x >= 0
filter
string

URL-encoded JSON AND/OR filter tree for complex queries. A node is a group {"and":[...]} / {"or":[...]} or a leaf — a bracket-notation string "field[operator]=value" (the same syntax as the flat params above). Composes as an additional AND alongside the bracket-notation filters. Max nesting depth 3, max 50 conditions.

Response

Default Response

items
object[]
required
total
number
required

Total number of items available

limit
number
required

Number of items returned

offset
number
required

Number of items skipped

total_assets
integer