DocsBuilding AppsInstalling IntercomAPI & Webhook ReferenceCanvas Kit Reference
DocsApp StoreForumBlogYour Apps

Retrieve an admin

Example Request & Response

$ curl https://api.intercom.io/admins/493881 \
-H 'Authorization:Bearer <Your access token>' \
-H 'Accept: application/json'
HTTP/1.1 200 Ok

{
    "type": "admin",
    "id": "493881",
    "name": "Hoban Washburne",
    "email": "[email protected]",
    "away_mode_enabled": false,
    "away_mode_reassign": false,
    "team_ids": [
        814865
    ]
}
<?php
$admin = $intercom->admins->getAdmin("493881");
?>
Errors for admins without inbox seats

{
    "type": "error.list",
    "request_id": "0002miv9og586ig3aln0",
    "errors": [
        {
            "code": "action_forbidden",
            "message": "This admin does not have Inbox access permissions"
        }
    ]
}

You can fetch the details of a single admin.

Request Path Parameters

Parameter

Type

Required?

Description

id

String

Yes

The unique identifier of a given admin

Response

This will return an Admin object.