Preview Views
POST {{baseUrl}}/api/v2/views/preview
You can preview views by constructing the conditions in the proper format and nesting them under the view property. See Conditions reference. The output can also be controlled by passing in any of the following parameters and nesting them under the output property.
| Name | Type | Comment |
|---|---|---|
| columns | Array | The ticket fields to display. System fields are looked up by name, custom fields by title or id. See the View columns table |
| group_by | String | When present, the field by which the tickets are grouped |
| group_order | String | The direction the tickets are grouped. May be one of ascor desc |
| sort_order | String | The direction the tickets are sorted. May be one of ascor desc |
| sort_by | String | The ticket field used for sorting. This will either be a title or a custom field id. |
This endpoint is rate limited to 5 requests per minute, per view, per agent.
Allowed For
- Agents
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"columns":[{"id":"subject","title":"Subject"}],"rows":[{"subject":"en-US","ticket":{}}]}