Docs Blog Sign in

Views

Views are saved filter and column configurations for the ticket list.

The view object

AttributeTypeDescription
idstringUnique identifier
namestringView name (max 128 characters)
descriptionstring | nullView description (max 512 characters)
scopestringpersonal or workspace
filtersobjectFilter configuration (see below)
columnsarrayColumn identifiers to display
ownerIdstringCreator’s user ID
isDefaultbooleanWhether this is the default view
positionintegerDisplay order
createdAtstringCreation time (ISO 8601 UTC)
updatedAtstringLast update time (ISO 8601 UTC)

Filters

{
  "all": [{ "field": "status", "op": "is", "value": "open" }],
  "any": [{ "field": "priority", "op": "is", "value": "urgent" }]
}

Available columns

status, requesterEmail, subject, assignee, priority, lastUpdatedAt, createdAt, type, requesterName, tags, id, sla, group, sentiment, customField:*

List views

GET /helpdesk/api/views

Create a view

POST /helpdesk/api/views

Requires agent role or above.

Request body

{
  "name": "Urgent Open Tickets",
  "scope": "workspace",
  "filters": {
    "all": [
      { "field": "status", "op": "is", "value": "open" },
      { "field": "priority", "op": "is", "value": "urgent" }
    ]
  },
  "columns": ["status", "subject", "assignee", "priority", "sla", "lastUpdatedAt"]
}

Update a view

PATCH /helpdesk/api/views/:viewId

Delete a view

DELETE /helpdesk/api/views/:viewId

Execute a view

GET /helpdesk/api/views/:viewId/tickets

Returns the tickets matching the view’s filters with pagination.

Query parameters

ParameterTypeDescription
pageintegerPage number
limitintegerResults per page
sort_bystringcreated_at, last_updated_at, priority, status, sla_next_due_at, sentiment
sort_orderstringasc or desc
status_categorystringAdditional status filter
prioritystringAdditional priority filter
assignee_idstringAdditional assignee filter
group_idstringAdditional group filter
tagsstringComma-separated tags
sla_statusstringFilter by SLA status

Reorder views

PATCH /helpdesk/api/views/reorder
{ "viewIds": ["view_1", "view_2", "view_3"] }