Skip to navigation
Atomicwork Public APIRequests

Get requests by filter

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_OFTicket status (e.g. OPEN, IN_PROGRESS, RESOLVED, CLOSED).
typeIS_ANY_OFRequest type (e.g. INCIDENT, SERVICE_REQUEST, GENERAL_REQUEST).
assignee_idIS_ANY_OFAssigned agent user ID.
requester_idIS_ANY_OFRequester user ID.
created_atIS_BETWEENCreation timestamp (ISO 8601). Use for date range filtering.
updated_atIS_BETWEENLast-updated timestamp (ISO 8601).

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": "OPEN"
      },
      {
        "value": "IN_PROGRESS"
      }
    ]
  },
  {
    "attribute": "created_at",
    "operator": "IS_BETWEEN",
    "values": [
      {
        "value": "2024-01-01T00:00:00Z"
      },
      {
        "value": "2024-12-31T23:59:59Z"
      }
    ]
  }
]

Authentication

X-Api-Keystring
API Key authentication via header

Headers

X-Workspace-IdstringOptional

Query parameters

filter_namestringRequired3-40 characters
sort_orderenumOptional
sortstringOptional

Generic ordered sort as a compact string, e.g. created_at:ASC,subject:DESC. Field keys are validated server-side against the view-column allowlist. When present, takes precedence over the legacy sort_order enum.

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

Request

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

Response

Successful response