younifyd
Menu

List Admins

List all admins

GET/admins

Use it in a workflow

  1. Add a step and choose the Intercom connector.
  2. Pick the List Admins action (under Admins).
  3. Fill in the fields below, then reference the result from later steps as {{listAdmins.response.data}}.

Request

Query parameters

display_avatarboolean

If set to true, the response will include the admin's avatar object containing the image URL. Defaults to false.

Headers

Intercom-Versionstring

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

One of1.01.11.21.31.42.02.12.22.32.42.52.62.72.82.92.102.112.122.132.142.152.16Default "2.16"

Response

Returns 200 with an object. Read it in later steps with {{listAdmins.response.data.<field>}}.

typestring

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

adminsarray<object>

A list of admins associated with a given workspace.

typestring

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

idstring

The id representing the admin.

namestring

The name of the admin.

emailstring

The email of the admin.

job_titlestring

The job title of the admin.

away_mode_enabledboolean

Identifies if this admin is currently set in away mode.

away_mode_reassignboolean

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

away_status_reason_idinteger

The unique identifier of the away status reason

has_inbox_seatboolean

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

team_idsarray<integer>

This object represents the avatar associated with the admin.

avatarstring (uri)

Image for the associated team or teammate

team_priority_levelobject2 fields

Admin priority levels for teams

roleobject3 fields

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

json
{
  "type": "admin.list",
  "admins": [
    {
      "type": "admin",
      "id": "1295",
      "name": "Joe Example",
      "email": "jdoe@example.com",
      "job_title": "Associate",
      "away_mode_enabled": false,
      "away_mode_reassign": false,
      "away_status_reason_id": 12345,
      "has_inbox_seat": true,
      "team_ids": [
        814865
      ],
      "avatar": "https://picsum.photos/200/300",
      "team_priority_level": {
        "primary_team_ids": [
          814865
        ],
        "secondary_team_ids": [
          493881
        ]
      }
    }
  ]
}

Need more? See the Intercom guide for connection setup and behaviour shared by every action.