Find an admin by email

Request

You can find an admin in your workspace by their email address. The response is the same as retrieving the admin by id.

Requires the read_admins OAuth scope.

Security

bearerAuth

Query

emailstringrequired

The email address of the admin. Matching ignores case.

Example:email=admin9@email.com

Intercom-Versionstring(intercom_version)

Intercom API version.
If you omit the header, the API uses the version set in your app package, and 1.0 if none is set.

Enum:"1.0""1.1""1.2""1.3""1.4""2.0""2.1""2.2""2.3""2.4"

Example:Preview

curl -i -X GET \
  'https://api.intercom.io/admins/find_by_email?email=admin9%40email.com' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Intercom-Version: Preview'

Responses

Admin found

Bodyapplication/json

typestring

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

Example:"admin"

idstring

The id representing the admin.

Example:"1295"

namestring

The name of the admin.

Example:"Joe Example"

emailstring

The email of the admin.

Example:"jdoe@example.com"

job_titlestring

The job title of the admin.

Example:"Associate"

away_mode_enabledboolean

Identifies if this admin is currently set in away mode.

Example:false

away_mode_reassignboolean

Identifies if this admin is set to automatically reassign new conversations to the apps default inbox.

Example:false

away_status_reason_idinteger or null

The unique identifier of the away status reason. Not returned by List all admins.

Example:12345

has_inbox_seatboolean

Identifies if this admin has a paid inbox seat to restrict/allow features that require them.

Example:true

team_idsArray of integers

The ids of the teams the admin belongs to. When the workspace has a default team, its id is the last item.

Example:

[
  814865
]

avatarobject or null

The teammate's avatar image. On List all admins it is only included when display_avatar is true. Elsewhere it is left out when the teammate has neither an uploaded avatar nor a gravatar.

team_priority_levelobject or null(Team Priority Level)

Admin priority levels for teams

roleobject or null

The role assigned to this admin. Only present if the admin has a role assigned.

Response

{
  "type": "admin",
  "id": "991267468",
  "name": "Ciaran9 Lee",
  "email": "admin9@email.com",
  "away_mode_enabled": false,
  "away_mode_reassign": false,
  "has_inbox_seat": true,
  "away_status_reason_id": null,
  "team_ids": [
    814865,
    991267903
  ],
  "team_priority_level": {
    "primary_team_ids": [ … ]
  }
}