List saved inbox views

List the saved inbox views the caller can see — their own, the ones shared with them or their teams, and the organization-wide ones.

GET /inbox-views

List saved inbox views

cURL

curl --request GET \
  --url http://localhost:8080/inbox-views \
  --header 'Authorization: Bearer <token>'

200

[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "filters": {
      "date": {
        "from": "2023-11-07T05:31:56Z",
        "to": "2023-11-07T05:31:56Z",
        "preset": "today"
      },
      "channels": [
        "web"
      ],
      "status": [
        1073741823
      ],
      "sub_status_ids": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "ai_closure": [
        "assumed_resolved"
      ],
      "sentiment": [
        "angry"
      ],
      "assignees": [
        1073741823
      ],
      "team_ids": [
        "<string>"
      ],
      "support_team_ids": [
        "<string>"
      ],
      "contact_ids": [
        "<string>"
      ],
      "ticket_number": 1073741823,
      "language": [
        "<string>"
      ],
      "tags": [
        "<string>"
      ],
      "waiting_on": "customers",
      "custom_data": [
        {}
      ]
    },
    "advanced": true,
    "sort_by": "last_message_at",
    "sort_order": "asc",
    "group_by": "tags",
    "group_by_attribute": "<string>",
    "shared_with_user_ids": [
      0
    ],
    "shared_with_team_ids": [
      "<string>"
    ],
    "visibility": "organization",
    "created_by_user_id": 0,
    "can_edit": true,
    "can_delete": true,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
]

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

200

application/json

Default Response

id · string<uuid> · required

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

name · string · required

Name shown in the inbox view picker

filters · object | null · required

The saved filter set. null when advanced is true — the view uses filters this API cannot express.

Show child attributes

advanced · boolean · required

True when the view was built in the dashboard with OR/exclude groups or filters outside this API's vocabulary. Its filters read back as null, and updating filters on it REPLACES the whole saved query with the simple set you send.

sort_by · enum<string> | null · required

Sort field the view opens with

Available options: last_message_at, created_at, sla_urgency, snoozed_until

sort_order · enum<string> | null · required

Sort direction the view opens with

Available options: asc, desc

group_by · enum<string> | null · required

Field sessions are grouped by in the list, when the view groups them

Available options: tags, contact_attribute, session_attribute, channel, assignee_id, status, ai_closure_type, language, inbox_id

group_by_attribute · string | null · required

Exact attribute key for contact or session attribute grouping, or null when no key is set.

shared_with_user_ids · integer[] · required

User ids the view is shared with. Empty (with no teams) means the whole org.

Required range: -9007199254740991 <= x <= 9007199254740991

shared_with_team_ids · string[] · required

Team ids the view is shared with. Empty (with no users) means the whole org.

visibility · enum<string> · required

Available options: organization, personal, restricted

created_by_user_id · integer · required

Required range: -9007199254740991 <= x <= 9007199254740991

can_edit · boolean · required

Whether the calling user may update this view

can_delete · boolean · required

Whether the calling user may delete this view

created_at · string<date-time> · required

updated_at · string<date-time> · required