Get changes by filter

POST

https://{tenant}.atomicwork.com/api/v1/workspaces/:workspace_id/change-management/changes/list

POST

/api/v1/workspaces/:workspace_id/change-management/changes/list

curl -X POST "https://{tenant}.atomicwork.com/api/v1/workspaces/1/change-management/changes/list?filter_name=filter_name&page=1&sort_order=CREATED_AT_DESC" \
     -H "X-Workspace-Id: {{workspace_id}}" \
     -H "X-Api-Key: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '[
  {
    "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"
      }
    ]
  }
]'

200Change Management_postapi_v1_workspaces__workspace_id__change_management_changes_list_example

{}

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

[
  {
    "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.

Query parameters

filter_namestringRequired3-40 characters

sort_orderenumOptional

Allowed values:

sortstringOptional<=256 characters

Comma-separated sort keys as field:direction (e.g. status:asc,created_at:desc), up to 2 keys. Field keys come from GET /views/CHANGE/fields (entries with sortable: true). Takes precedence over sort_order. Invalid/unknown fields -> 400.

pageintegerRequired1-1000Defaults 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