Home
/
REST API Reference
/
Admins
/
Identify an admin

Identify an admin

You can view the currently authorised admin along with the embedded app object (a "workspace" in legacy terminology).

🚧 Single Sign On

If you are building a custom "Log in with Intercom" flow for your site, and you call the /me endpoint to identify the logged-in user, you should not accept any sign-ins from users with unverified email addresses as it poses a potential impersonation security risk.

SecurityHTTP: bearerAuth
Request
header Parameters
Intercom-Version
string (intercom_version)
Default: 2.10

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

Enum: "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" "Unstable"
Example: 2.10
get
/me
Request samples
Responses
200
Successful response
Response Schema: application/json
type
string 
String representing the object's type. Always has the value admin.
 
id
string 
The id representing the admin.
 
name
string 
The name of the admin.
 
email
string 
The email of the admin.
 
job_title
string 
The job title of the admin.
 
away_mode_enabled
boolean 
Identifies if this admin is currently set in away mode.
 
away_mode_reassign
boolean 
Identifies if this admin is set to automatically reassign new conversations to the apps default inbox.
 
has_inbox_seat
boolean 
Identifies if this admin has a paid inbox seat to restrict/allow features that require them.
 
team_ids
Array of integers 
This is a list of ids of the teams that this admin is part of.
 
object 
This object represents the avatar associated with the admin.
 
email_verified
boolean or null 
Identifies if this admin's email is verified.
 
object or null (App)  
App is a workspace on Intercom
 
Response samples
application/json
{
"type": "admin",
"id": "991282282",
"email": "admin1@email.com",
"name": "Ciaran1 Lee",
"email_verified": true,
"app": {
"type": "app",
"id_code": "this_is_an_id1_that_should_be_at_least_40",
"name": "MyApp 1",
"created_at": 1712222856,
"secure": false,
"identity_verification": false,
"timezone": "America/Los_Angeles",
"region": "US"
},
"avatar": {
"type": "avatar",
"image_url": "https://static.intercomassets.com/assets/default-avatars/admins/128.png"
},
"has_inbox_seat": true
}