Get changes 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`	Change status (e.g. `DRAFT`, `IN_REVIEW`, `APPROVED`, `IMPLEMENTED`).
`type`	`IS_ANY_OF`	Change type.
`assignee_id`	`IS_ANY_OF`	Assigned agent user ID.
`created_at`	`IS_BETWEEN`	Creation 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

1 [
2   {
3     "attribute": "status",
4     "operator": "IS_ANY_OF",
5     "values": [
6       {
7         "value": "DRAFT"
8       },
9       {
10         "value": "IN_REVIEW"
11       }
12     ]
13   },
14   {
15     "attribute": "created_at",
16     "operator": "IS_BETWEEN",
17     "values": [
18       {
19         "value": "2024-01-01T00:00:00Z"
20       },
21       {
22         "value": "2024-12-31T23:59:59Z"
23       }
24     ]
25   }
26 ]

### 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` | Change status (e.g. `DRAFT`, `IN_REVIEW`, `APPROVED`, `IMPLEMENTED`). | | `type` | `IS_ANY_OF` | Change type. | | `assignee_id` | `IS_ANY_OF` | Assigned agent user ID. | | `created_at` | `IS_BETWEEN` | Creation 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** ```json [ { "attribute": "status", "operator": "IS_ANY_OF", "values": [ { "value": "DRAFT" }, { "value": "IN_REVIEW" } ] }, { "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.

Headers

X-Workspace-IdstringOptional

Query parameters

filter_namestringRequired3-40 characters

sort_orderenumOptional

Allowed values:

pageintegerRequired1-100Defaults to 1

per_pageintegerOptional1-100Defaults to 25

paginatebooleanOptionalDefaults to true

Request

This endpoint expects a list of objects.

attributestringOptional

operatorenumOptional

valueslist of objectsOptional

Response

Successful response