List Active Views
GET {{baseUrl}}/api/v2/views/active?access=<string>&group_id=<integer>&sort_by=<string>&sort_order=<string>
Lists active shared and personal views available to the current user.
Sideloads
The following sideloads are supported:
Name | Will sideload |
---|---|
app_installation | The app installation that requires each view, if present |
permissions | The permissions for each view |
Pagination
- Offset pagination
See Pagination.
Returns a maximum of 100 records per page.
Allowed For
- Agents
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
access | string | Only views with given access. May be "personal", "shared", or "account" | |
group_id | string | Only views belonging to given group | |
sort_by | string | Possible values are "alphabetical", "created_at", or "updated_at". Defaults to "position" | |
sort_order | string | One of "asc" or "desc". Defaults to "asc" for alphabetical and position sort, "desc" for all others |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"count":2,"next_page":null,"previous_page":null,"views":[{"active":true,"conditions":{},"description":"View for recent tickets","execution":{},"id":25,"position":3,"restriction":{},"title":"Tickets updated less than 12 Hours"},{"active":true,"conditions":{},"description":"View for tickets that are not assigned","execution":{},"id":23,"position":7,"restriction":{},"title":"Unassigned tickets"}]}