Sign in
Views

List Active Views

Lists active shared and personal views available to the current user.

Sideloads

The following sideloads are supported:

NameWill sideload
app_installationThe app installation that requires each view, if present
permissionsThe permissions for each view

Pagination

  • Offset pagination

See Pagination.

Returns a maximum of 100 records per page.

Allowed For

  • Agents
get/api/v2/views/active

Query parameters

accessstring

Only views with given access. May be "personal", "shared", or "account"

group_idinteger

Only views belonging to given group

sort_bystring

Possible values are "alphabetical", "created_at", or "updated_at". Defaults to "position"

sort_orderstring

One of "asc" or "desc". Defaults to "asc" for alphabetical and position sort, "desc" for all others

Response

Success response

countinteger
next_pagestring nullable
previous_pagestring nullable

Example response

{
  "views": [
    {
      "active": true,
      "conditions": {
        "all": [
          {
            "field": "status",
            "operator": "less_than",
            "value": "solved"
          },
          {
            "field": "assignee_id",
            "operator": "is",
            "value": "296220096"
          }
        ],
        "any": []
      },
      "default": false,
      "description": "View for recent tickets",
      "execution": {
        "columns": [
          {
            "id": "status",
            "title": "Status"
          },
          {
            "id": "updated",
            "title": "Updated"
          },
          {
            "id": 5,
            "title": "Account",
            "type": "text",
            "url": "https://example.zendesk.com/api/v2/ticket_fields/5.json"
          }
        ],
        "group": {
          "id": "status",
          "order": "desc",
          "title": "Status"
        },
        "sort": {
          "id": "updated",
          "order": "desc",
          "title": "Updated"
        }
      },
      "id": 25,
      "position": 8,
      "restriction": {
        "id": 4,
        "type": "User"
      },
      "title": "Tickets updated <12 Hours"
    }
  ]
}

Changes