v51

latestOpenAPI 3.0.1MITraw.githubusercontent.com2026-08-01150230854.3 KB
Admins

List all admins

You can fetch a list of admins for a given workspace.

get/admins

Query parameters

display_avatarboolean

If set to true, the response will include the admin's avatar object containing the image URL. Defaults to false.

Headers

Intercom-Version'1.0' | '1.1' | '1.2' | '1.3' | '1.4' | '2.0' | '2.1' | '2.2' | '2.3' | '2.4' | '2.5' | '2.6' | '2.7' | '2.8' | '2.9' | '2.10' | '2.11' | '2.12' | '2.13' | '2.14'

Intercom API version.</br>By default, it's equal to the version set in the app package.

Example:2.14

Response

Successful response

typestring

String representing the object's type. Always has the value admin.list.

Example response

{
  "type": "admin.list",
  "admins": [
    {
      "type": "admin",
      "id": "1295",
      "name": "Joe Example",
      "email": "jdoe@example.com",
      "job_title": "Associate",
      "away_status_reason_id": 12345,
      "has_inbox_seat": true,
      "team_ids": [
        814865
      ],
      "avatar": "https://picsum.photos/200/300",
      "team_priority_level": {
        "primary_team_ids": [
          814865
        ],
        "secondary_team_ids": [
          493881
        ]
      }
    }
  ]
}