API Reference

The View object

A view allows you to filter and sort the tickets of your account according to one or more criteria. For example, you can have a view that displays tickets having the tag urgent, or a view that display closed tickets, etc...
Views are not like inboxes because a ticket can be present in 1 or more views if this one matches criterias of these views.

View properties

integer

ID of the view.

string | null

Category is an internal, read-only field used to identify system and user views.Example of system views: Trash or Spam. System views cannot be deleted.

ISO 8601 datetime

When the view was created.

ISO 8601 datetime

When the view was deactivated.

object

Object describing how the view appears in our applications. Currently only supports emoji field that shows before the view's name.

array

List of object's attributes to be displayed in the UI of our applications.

string

The logic used to filter the items to be displayed in the view (as JavaScript code).

string

The name of the view.

string

Name of the object's attribute used to sort the items of the view.

string

Sort direction of the items displayed in the view. Options: asc or desc.

string | null

Text used to search for items matching the query.

array
None
array
None
string

DEPRECATED - URL-compatible name of the view.

string

Type of objects the view is applied on.

string

URI of the object (auto-generated)

string

Visibility of the view. Possible values are: - public: any user of your helpdesk can see it - shared: users listed under shared_with_users attribute and teams listed under shared_with_teams attribute can see it. All admins and lead agents will see it as well, even if they are not explicitly listed in the shared_with_users attribute. - private: only the single user listed under shared_with_users attribute can see it

View example object

{
  "id": 123,
  "category": "user",
  "created_datetime": "2019-11-23T15:59:41.966927",
  "deactivated_datetime": "2020-01-30T11:04:34.345123",
  "decoration": {
    "emoji": "\ud83d\ude4f"
  },
  "fields": [
    "id",
    "details",
    "tags"
  ],
  "filters": "eq(ticket.assignee_user.id, '{{current_user.id}}') && eq(ticket.status, 'open')",
  "name": "My view",
  "order_by": "updated_datetime",
  "order_dir": "desc",
  "search": "where is my order?",
  "slug": "my-tickets",
  "type": "ticket-list"
}