FRfrontapp
Views

Get view

Fetch a view.

Required scope: views:read

get/views/{view_id}

Request

  • Base URL
    https://api2.frontapp.com
  • URL
    https://api2.frontapp.com/views/{view_id}
  • Auth
    HTTP bearer

Path parameters

view_idstring required

The view ID

Response

A view

idstring required

Unique identifier of the shared view

namestring required

Name of the shared view

highlightstring nullable required

Color highlight for the view

inbox_idsstring[] required

List of inbox IDs included in the view

tag_idsstring[] required

List of tag IDs to filter by

not_tag_idsstring[] required

List of tag IDs to exclude

no_tagsboolean required

Whether to filter for conversations without tags

assignee_idsstring[] required

List of assignee IDs to filter by

not_assignee_idsstring[] required

List of assignee IDs to exclude

Example response

{
  "_links": {
    "self": "https://yourCompany.api.frontapp.com/views/lns_abc123",
    "related": {
      "owner": "https://yourCompany.api.frontapp.com/teams/tim_xyz"
    }
  },
  "id": "lns_abc123",
  "name": "High Priority Support",
  "highlight": "pink"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.