> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Intercom: List Admins

> List the admins (teammates) in an Intercom workspace. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

List the admins (teammates) in an Intercom workspace.

> [!NOTE]
>
> Tool ID: `intercom_list_admins`

## Run this action

Use the TypeScript SDK for one call. Use `ctx.tools.execute(...)` inside a Play for durable calls, scheduled calls, or CSV processing.

```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'intercom_list_admins',
  {
    "display_avatar": true
  },
);

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute intercom_list_admins --input '{
  "display_avatar": true
}' --json
```

## Example response

The SDK returns this shape at `result.toolResponse.raw`. The example values illustrate the response.

```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
  "data": {
    "type": "example",
    "admins": [
      {
        "type": "example",
        "id": "id_123",
        "name": "Example"
      }
    ]
  }
}
```

Use `deepline describe intercom_list_admins --json` for the latest machine-readable contract.

## Input reference

You can fetch a list of admins for a given workspace.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.display_avatar` | `boolean` | No | — | If set to true, the response will include the admin's avatar object containing the image URL. Defaults to false. |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "You can fetch a list of admins for a given workspace.",
    "properties": {
      "display_avatar": {
        "type": "boolean",
        "description": "If set to true, the response will include the admin's avatar object containing the image URL. Defaults to false."
      }
    },
    "required": [],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | A list of admins associated with a given workspace. |
| `result.data.type` | `string` | No | — | String representing the object's type. Always has the value `admin.list`. |
| `result.data.admins` | `array` | No | — | A list of admins associated with a given workspace. |
| `result.data.admins[].type` | `string` | No | — | String representing the object's type. Always has the value `admin`. |
| `result.data.admins[].id` | `string` | No | — | The id representing the admin. |
| `result.data.admins[].name` | `string` | No | — | The name of the admin. |
| `result.data.admins[].email` | `string` | No | — | The email of the admin. |
| `result.data.admins[].job_title` | `string` | No | — | The job title of the admin. |
| `result.data.admins[].away_mode_enabled` | `boolean` | No | — | Identifies if this admin is currently set in away mode. |
| `result.data.admins[].away_mode_reassign` | `boolean` | No | — | Identifies if this admin is set to automatically reassign new conversations to the apps default inbox. |
| `result.data.admins[].away_status_reason_id` | `integer \| null` | No | — | The unique identifier of the away status reason |
| `result.data.admins[].has_inbox_seat` | `boolean` | No | — | Identifies if this admin has a paid inbox seat to restrict/allow features that require them. |
| `result.data.admins[].team_ids` | `array` | No | — | This object represents the avatar associated with the admin. |
| `result.data.admins[].avatar` | `string \| null` | No | — | Image for the associated team or teammate Format: `uri`. |
| `result.data.admins[].team_priority_level` | `object \| null` | No | — | Admin priority levels for teams |
| `result.data.admins[].team_priority_level.primary_team_ids` | `array \| null` | No | — | The primary team ids for the team |
| `result.data.admins[].team_priority_level.secondary_team_ids` | `array \| null` | No | — | The secondary team ids for the team |
| `result.meta` | `object` | No | — | Additional response metadata (status, paging). |

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "object",
        "description": "A list of admins associated with a given workspace.",
        "properties": {
          "type": {
            "type": "string",
            "description": "String representing the object's type. Always has the value `admin.list`."
          },
          "admins": {
            "type": "array",
            "description": "A list of admins associated with a given workspace.",
            "items": {
              "type": [
                "object",
                "null"
              ],
              "description": "Admins are teammate accounts that have access to a workspace.",
              "properties": {
                "type": {
                  "type": "string",
                  "description": "String representing the object's type. Always has the value `admin`."
                },
                "id": {
                  "type": "string",
                  "description": "The id representing the admin."
                },
                "name": {
                  "type": "string",
                  "description": "The name of the admin."
                },
                "email": {
                  "type": "string",
                  "description": "The email of the admin."
                },
                "job_title": {
                  "type": "string",
                  "description": "The job title of the admin."
                },
                "away_mode_enabled": {
                  "type": "boolean",
                  "description": "Identifies if this admin is currently set in away mode."
                },
                "away_mode_reassign": {
                  "type": "boolean",
                  "description": "Identifies if this admin is set to automatically reassign new conversations to the apps default inbox."
                },
                "away_status_reason_id": {
                  "type": [
                    "integer",
                    "null"
                  ],
                  "description": "The unique identifier of the away status reason"
                },
                "has_inbox_seat": {
                  "type": "boolean",
                  "description": "Identifies if this admin has a paid inbox seat to restrict/allow features that require them."
                },
                "team_ids": {
                  "type": "array",
                  "description": "This object represents the avatar associated with the admin.",
                  "items": {
                    "type": "integer"
                  }
                },
                "avatar": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "description": "Image for the associated team or teammate",
                  "format": "uri"
                },
                "team_priority_level": {
                  "type": [
                    "object",
                    "null"
                  ],
                  "description": "Admin priority levels for teams",
                  "properties": {
                    "primary_team_ids": {
                      "type": [
                        "array",
                        "null"
                      ],
                      "description": "The primary team ids for the team",
                      "items": {
                        "type": "integer"
                      }
                    },
                    "secondary_team_ids": {
                      "type": [
                        "array",
                        "null"
                      ],
                      "description": "The secondary team ids for the team",
                      "items": {
                        "type": "integer"
                      }
                    }
                  },
                  "additionalProperties": false
                }
              },
              "additionalProperties": false
            }
          }
        },
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Deepline cost

* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0` per pricing unit.
* Provider-native pricing may still exist outside Deepline credit billing.

## Related documentation

* [Intercom provider guide](https://deepline.com/docs/providers/intercom/guide.md)
* [SDK V2 quickstart](https://deepline.com/docs/sdk-v2/quickstart.md)
* [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md)
* [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.