v1

latestOpenAPI 3.1.02026-08-04147764567.0 KB

assets

Asset List with views, and filters.

Filtering

The request body is an array of filter objects. Send an empty array ([]) to retrieve all records.

Each filter object has the following fields:

Field	Type	Description
attribute	string	The field to filter on (see Supported attributes below)
operator	string	Comparison operator (see Available operators below)
values	array	One or more { "value": <scalar> } objects

Supported attributes

Attribute	Typical operator	Description
status	IS_ANY_OF	Asset status (e.g. IN_USE, AVAILABLE, RETIRED).
type_id	IS_ANY_OF	Asset type ID.
assigned_to_id	IS_ANY_OF	User ID the asset is assigned to.

Available operators

Operator	Meaning
EQUALS	Exact match
NOT_EQUALS	Exclude exact match
IN / IS_ANY_OF	Match any value in the list
IS_NOT_ANY_OF	Exclude all listed values
IS_BETWEEN	Inclusive range — pass exactly two values: [start, end]
IS_ON_OR_BEFORE / IS_ON_OR_AFTER	Date/time boundary comparisons
CONTAINS / TEXT_CONTAINS	Substring or set membership
IS_NULL / IS_NOT_NULL	Null checks — values array can be empty
STARTS_WITH / ENDS_WITH	String prefix/suffix match

Example

[
  {
    "attribute": "status",
    "operator": "IS_ANY_OF",
    "values": [
      {
        "value": "IN_USE"
      },
      {
        "value": "AVAILABLE"
      }
    ]
  }
]

post/api/v1/assets/list

Query parameters

sort_order'CREATED_AT_DESC' | 'CREATED_AT_ASC' | 'UPDATED_AT_DESC' | 'NAME_ASC' | 'NAME_DESC'

sortstring

Generic multi-column sort, comma-separated field:DIRECTION (e.g. display_name:ASC,created_at:DESC). Sortable fields are those advertised with sortable: true by the asset fields endpoint. Takes precedence over sort_order. Invalid/unknown fields -> 400.

pageinteger required

per_pageinteger

Headers

X-Api-Keystring required

X-Workspace-Idstring

Request body

attributestring

Response

Successful response

AssetsPostapiV1AssetsListResponse200 required

Empty response body