v1

latestOpenAPI 3.1.02026-08-04147764567.0 KB

requests

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

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:

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"
      }
    ]
  }
]

post/api/v1/requests/kanban

Headers

X-Api-Keystring required

X-Workspace-Idstring

Request body

view_namestring

group_bystring[] required

sortstring

page_sizeinteger

workspace_idinteger

Response

Successful response

RequestsPostapiV1RequestsKanbanResponse200 required

Empty response body