v1

latestOpenAPI 3.1.02026-07-24111290748.0 KB

Views

List views

List all views ordered by their id attribute. Current user variables ({{current_user...}}) present in views' filters will be replaced with the information of the user listing views.

get/api/views

Query parameters

order_by'created_datetime:asc' | 'created_datetime:desc'

Attribute used to order views.

cursorstring

Example:WyJuZXh0IiwgIjIwMjItMDEtMDFUMDE6MDA6MDAiLCAxMjNd

Value indicating your position in the list of all views. If omitted, the first views of the list will be returned.

limitinteger

Maximum number of views to return.

category'system' | 'user'

Filter views by category. Use 'system' to fetch only system views, 'user' to fetch only user views.

Response

A list of views.

objectstring required

uristring required

Example response

{
  "data": [
    {
      "id": 123,
      "category": "user",
      "created_datetime": "2019-11-23T15:59:41.966927",
      "deactivated_datetime": "2020-01-30T11:04:34.345123",
      "decoration": {
        "emoji": "🙏"
      },
      "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?",
      "shared_with_teams": [
        {
          "id": 123,
          "name": "Warehouse team"
        }
      ],
      "shared_with_users": [
        {
          "id": 1,
          "name": "John Smith",
          "meta": {
            "profile_picture_url": null
          }
        }
      ],
      "slug": "my-tickets",
      "uri": "/api/views/123/"
    }
  ]
}