Get requests by filter | Atomicwork

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`	Ticket status (e.g. `OPEN`, `IN_PROGRESS`, `RESOLVED`, `CLOSED`).
`type`	`IS_ANY_OF`	Request type (e.g. `INCIDENT`, `SERVICE_REQUEST`, `GENERAL_REQUEST`).
`assignee_id`	`IS_ANY_OF`	Assigned agent user ID.
`requester_id`	`IS_ANY_OF`	Requester user ID.
`created_at`	`IS_BETWEEN`	Creation timestamp (ISO 8601). Use for date range filtering.
`updated_at`	`IS_BETWEEN`	Last-updated timestamp (ISO 8601).

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": "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

Path parameters

workspace_idlongRequired

Workspace ID (numeric). Find yours under Settings → Workspace.

Query parameters

filter_namestringRequired3-40 characters

is_problembooleanOptional

sort_orderenumOptional

sortstringOptional

Generic ordered sort as a compact string, e.g. priority:DESC,created_at:ASC. 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_type_filterlist of enumsOptional

drilldown_tokenstringOptional

Opaque analytics drill-down token identifying one Request Overview V2 widget grouping (from POST /api/v2/workspaces/{workspace_id}/analytics/request). Restricts the result to the requests behind that widget number. It is combined with any other filters sent and re-validated against current data, so requests since deleted, moved, or no longer visible to the caller are absent. A grouping whose count was genuinely zero returns an empty result; a token that no longer resolves returns 410 DRILLDOWN_TOKEN_EXPIRED, so the caller re-runs the report rather than showing an empty list. When present, is_problem and request_type_filter are ignored — the widget query applies no request-type predicate, so any narrowing would disagree with the metric — and filter_name is forced to all server-side, so the value sent is not honoured; any duration filter is stripped.

Request

This endpoint expects a list of objects.

attributestringOptional

operatorenumOptional

valueslist of objectsOptional

Response

Successful response