Search Views
GET {{baseUrl}}/api/v2/views/search?query=<string>&access=<string>&active=<boolean>&group_id=<integer>&sort_by=<string>&sort_order=<string>&include=<string>
Pagination
- Offset pagination only
Allowed For
- Agents
Sideloads
The following sideloads are supported. For more information, see Side-loading.
| Name | Will sideload |
|---|---|
| app_installation | The app installation that requires each view, if present |
| permissions | The permissions for each view |
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
query | string | (Required) Query string used to find all views with matching title | |
access | string | Filter views by access. May be "personal", "shared", or "account" | |
active | string | Filter by active views if true or inactive views if false | |
group_id | string | Filter views by group | |
sort_by | string | Possible values are "alphabetical", "created_at", "updated_at", and "position". If unspecified, the views are sorted by relevance | |
sort_order | string | One of "asc" or "desc". Defaults to "asc" for alphabetical and position sort, "desc" for all others | |
include | string | A sideload to include in the response. See Sideloads |
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":false,"conditions":{},"description":"View for tickets that are not assigned","execution":{},"id":23,"position":7,"restriction":{},"title":"Unassigned tickets"}]}