Intercom API (unofficial showcase)
GET/admins

List admins

Lists the admins associated with the workspace. Set display_avatar to true to include each admin's avatar object and image URL; it defaults to false when omitted.

2 parameters
display_avatarbooleanoptional
Set to true to include each admin's avatar object and image URL. Defaults to false when omitted.
Intercom-Versionstringoptional
The Intercom API version to use. Supported versions include the listed values; defaults to 2.17 when omitted.
Allowed:1.01.11.21.31.42.02.12.22.32.42.52.6Default:2.17

2 status codes
200Returns a list of admin objects associated with the workspace; avatar details are included when requested.
typestringoptional
String representing the object's type. Always has the value `admin.list`.
adminsarray<Admin>optional
A list of admins associated with a given workspace.
401Returned when the request is unauthorized.

One documented failure

  • unauthorized

    Access Token Invalid

typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects

Error handling

A 401 is returned when the request is unauthorized. display_avatar controls whether avatar details are included and defaults to false when omitted; use a supported Intercom-Version, which defaults to 2.17.