# List all admins

You can fetch a list of admins for a given workspace.
Requires the `read_admins` OAuth scope.

Endpoint: GET /admins
Version: 2.17
Security: bearerAuth

## Query parameters:

  - `display_avatar` (boolean)
    If set to true, the response will include the admin's avatar object containing the image URL. Defaults to false.

## Header parameters:

  - `Intercom-Version` (string)

## Response 200 fields (application/json):

  - `type` (string)
    String representing the object's type. Always has the value `admin.list`.
    Example: admin.list

  - `admins` (array)
    A list of admins associated with a given workspace.

  - `admins.type` (string)
    String representing the object's type. Always has the value `admin`.
    Example: admin

  - `admins.id` (string)
    The id representing the admin.
    Example: 1295

  - `admins.name` (string)
    The name of the admin.
    Example: Joe Example

  - `admins.email` (string)
    The email of the admin.
    Example: jdoe@example.com

  - `admins.job_title` (string)
    The job title of the admin.
    Example: Associate

  - `admins.away_mode_enabled` (boolean)
    Identifies if this admin is currently set in away mode.
    Example: false

  - `admins.away_mode_reassign` (boolean)
    Identifies if this admin is set to automatically reassign new conversations to the apps default inbox.
    Example: false

  - `admins.away_status_reason_id` (integer)
    The unique identifier of the away status reason. Not returned by List all admins.
    Example: 12345

  - `admins.has_inbox_seat` (boolean)
    Identifies if this admin has a paid inbox seat to restrict/allow features that require them.
    Example: true

  - `admins.team_ids` (array)
    The ids of the teams the admin belongs to. When the workspace has a default team, its id is the last item.
    Example: [814865]

  - `admins.avatar` (object)
    The teammate's avatar image. On List all admins it is only included when `display_avatar` is `true`. Elsewhere it is left out when the teammate has neither an uploaded avatar nor a gravatar.

  - `admins.avatar.type` (string)
    Value is `avatar`. Returned by List all admins only.
    Example: avatar

  - `admins.avatar.image_url` (string)
    The URL of the avatar image.
    Example: https://picsum.photos/200/300

  - `admins.team_priority_level` (object)
    Admin priority levels for teams

  - `admins.team_priority_level.primary_team_ids` (array)
    The primary team ids for the team
    Example: [814865]

  - `admins.team_priority_level.secondary_team_ids` (array)
    The secondary team ids for the team
    Example: [493881]

  - `admins.role` (object)
    The role assigned to this admin. Only present if the admin has a role assigned.

  - `admins.role.type` (string)
    String representing the object's type. Always has the value `role`.
    Example: role

  - `admins.role.id` (string)
    The id of the role.
    Example: 1

  - `admins.role.name` (string)
    The name of the role.
    Example: Support Agent

## Response 401 fields (application/json):

  - `type` (string, required)
    The type is error.list
    Example: error.list

  - `request_id` (string)
    Example: f93ecfa8-d08a-4325-8694-89aeb89c8f85

  - `errors` (array, required)
    An array of one or more error objects

  - `errors.code` (any, required)
    A string indicating the kind of error, used to further qualify the HTTP response code. A few request validation errors send an HTTP status code as an integer here instead, for example `422`.
    Example: unauthorized

  - `errors.message` (string)
    Optional. Human readable description of the error.
    Example: Access Token Invalid