---
title: "List inbox access"
method: GET
path: "/inboxes/{inbox_id}/teammates"
tags: ["Inboxes"]
---

# List inbox access

`GET /inboxes/{inbox_id}/teammates`

List the teammates with access to an inbox.

Required scope: `teammates:read`

## Path parameters

- `inbox_id` string, required

## Response `200`

Array of teammates

- object
  - `_links` object
    - `self` string — Link to resource
  - `_results` TeammateResponse[]
    - `_links` object, required
      - `self` string — Link to resource
      - `related` object
        - `inboxes` string — Link to teammate's inboxes
        - `conversations` string — Link to teammate's conversations
        - `botSource` string — Link to the source resource of the bot (e.g. rule)
    - `id` string, required — Unique identifier of the teammate
    - `email` string, required — Email address of the teammate
    - `username` string, required — Username of the teammate (used for "@" mentions)
    - `first_name` string, required — First name of the teammate
    - `last_name` string, required — Last name of the teammate
    - `is_admin` boolean, required — Whether or not the teammate is an admin in your company
    - `is_available` boolean, required — Whether or not the teammate is available
    - `is_blocked` boolean, required — Whether or not the teammate account has been blocked
    - `type` 'user' | 'visitor' | 'ai' | 'api' | 'application' | 'bulk_reply' | 'csat' | 'integration' | 'macro' | 'rule' | 'smart_csat', required — Type of the teammate, normal teammates are denoted as "user", while visitors are denoted as "visitor". Bot users are denoted by their parent resource type. The following bot types are available: * ai: acting on behalf of an AI * api: acting on behalf of OAuth clients * application: acting on behalf of an Application * bulk_reply: acting on behalf of a Bulk Reply * csat: used for authoring CSAT response comments * integration: acting on behalf of an Integration * macro: acting on behalf of a Macro, author of comments and drafts * rule: acting on behalf of a Rule, author of comments and drafts * smart_csat: acting on behalf of a Smart CSAT
    - `custom_fields` CustomFieldParameter, required — An object whose key is the `name` property defined for the custom field in the Front UI. The value of the key must use the same `type` specified for the custom field, as described in https://dev.frontapp.com/reference/custom-fields

---

[API](https://skmtc.net/frontapp/apis/core-api.md) · [All operations](https://skmtc.net/frontapp/apis/core-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/frontapp/core-api/versions/76d1eaa2d0eb/schema)