Skip to navigation
Atomicwork Public APIRequests

Load a request Kanban board (1D or 2D), single call

View as Markdown

Filtering

Use the filters field to narrow results. Pass an empty array or omit the field 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

Request

This endpoint expects an object.
group_bylist of stringsRequired
view_namestringOptional
filterslist of objectsOptional
sortstringOptionalDefaults to created_at:desc
page_sizeintegerOptional1-100Defaults to 25
workspace_idlongOptional

Response

Successful response