Intercom API (unofficial showcase)
GET/admins/{admin_id}

Retrieve an admin

Retrieves the details of a specific admin account. Use the admin identifier to view the admin's profile, away settings, team assignments, and role information when present.

2 parameters
admin_idintegerrequired
The integer identifier of the admin to retrieve.
Intercom-Versionstringoptional
Selects the Intercom API version. Defaults to `2.17` when omitted; the schema defines the accepted version values.
Allowed:1.01.11.21.31.42.02.12.22.32.42.52.6Default:2.17

3 status codes
200Returns an admin object containing the admin's identifier, name, email, job title, away settings, team identifiers, avatar, and role when assigned.
typestringoptional
String representing the object's type. Always has the value `admin`.
idstringoptional
The id representing the admin.
namestringoptional
The name of the admin.
emailstringoptional
The email of the admin.
job_titlestringoptional
The job title of the admin.
away_mode_enabledbooleanoptional
Identifies if this admin is currently set in away mode.
away_mode_reassignbooleanoptional
Identifies if this admin is set to automatically reassign new conversations to the apps default inbox.
away_status_reason_idintegeroptional
The unique identifier of the away status reason
has_inbox_seatbooleanoptional
Identifies if this admin has a paid inbox seat to restrict/allow features that require them.
team_idsarray<integer>optional
This object represents the avatar associated with the admin.
avatarstringoptional
Image for the associated team or teammate
team_priority_levelobjectoptional
Admin priority levels for teams
roleobjectoptional
The role assigned to this admin. Only present if the admin has a role assigned.
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
404Returned when no admin exists with the given `admin_id`.

One documented failure

  • admin_not_found

    Admin not found

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. A 404 is returned when the admin cannot be found. The admin_id path parameter must identify the admin to retrieve.