Skip to navigation
Atomicwork Public APIAssets

Asset List with views, and filters.

View as Markdown

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:

FieldTypeDescription
attributestringThe field to filter on (see Supported attributes below)
operatorstringComparison operator (see Available operators below)
valuesarrayOne or more { "value": <scalar> } objects

Supported attributes

AttributeTypical operatorDescription
statusIS_ANY_OFAsset status (e.g. IN_USE, AVAILABLE, RETIRED).
type_idIS_ANY_OFAsset type ID.
assigned_to_idIS_ANY_OFUser ID the asset is assigned to.

Available operators

OperatorMeaning
EQUALSExact match
NOT_EQUALSExclude exact match
IN / IS_ANY_OFMatch any value in the list
IS_NOT_ANY_OFExclude all listed values
IS_BETWEENInclusive range — pass exactly two values: [start, end]
IS_ON_OR_BEFORE / IS_ON_OR_AFTERDate/time boundary comparisons
CONTAINS / TEXT_CONTAINSSubstring or set membership
IS_NULL / IS_NOT_NULLNull checks — values array can be empty
STARTS_WITH / ENDS_WITHString prefix/suffix match

Example

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

Authentication

X-Api-Keystring
API Key authentication via header

Headers

X-Workspace-IdstringOptional

Query parameters

sort_orderenumOptional
Allowed values:
sortstringOptional<=256 characters

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.

pageintegerRequired>=1Defaults to 1
per_pageintegerOptional1-1000Defaults to 25

Request

This endpoint expects a list of objects.
attributestringOptional
operatorenumOptional
valueslist of objectsOptional

Response

Successful response