# List People to Mention

> Lists the people you can @mention in a comment or an approval note: the workspace team and reviewers, sorted by name.

- **URL**: https://orshot.com/docs/api-reference/approvals-people-list

---

The Approvals API is available on Enterprise plans, or through first-party apps (the Orshot app and the Orshot MCP server). This endpoint needs [`read` access](/docs/api-reference/approvals-overview#access-levels).
See [Enterprise pricing](https://orshot.com/pricing) to get access.

Lists the people you can @mention in a comment or an approval note: the workspace team and reviewers, sorted by name. Write a mention as `@[Name](user:<id>)` with an id from this list. Reviewers limited to some approval flows get the team plus the reviewers who share one of their flows, and never see emails. Someone who can't see the template keeps the mention in the text but is not notified.

## Endpoint

```markdown tab="Endpoint"
https://api.orshot.com/v1/approvals/people
```

## Headers

| Header | Required | Description |
| ------ | -------- | ----------- |
| `Authorization` | Yes | `Bearer <API key or OAuth token>` |
| `x-workspace-id` | No | OAuth tokens with several workspaces: the workspace to act in. API keys ignore it. |
| `X-Orshot-User-Id` | No | API keys only: the user id of the owner, admin or member this call is for. See Acting for a Team Member below. |
| `X-Session-Id` | No | Groups the calls of one agent or MCP session in the activity history. |

## Acting for a Team Member

With an API key, you can send `X-Orshot-User-Id` with the user id of an owner, admin or member of the workspace to make this call for them. The answer then follows both the key's access level and that person's own access. See [acting for a team member](https://orshot.com/docs/api-reference/approvals-overview#acting-for-a-team-member).

## Request

**Request**
```js
await fetch("https://api.orshot.com/v1/approvals/people", {
  headers: { Authorization: "Bearer <ORSHOT_API_KEY>" },
});
```

**Response**
```json
{
  "people": [
    {
      "id": "0f3a6c9d-2b7e-4d15-8a4c-6e1b9f2d7c30",
      "name": "Alex Kim",
      "email": "alex@acme.com",
      "role": "admin",
      "avatarUrl": null
    },
    {
      "id": "4e9b1d7c-3f2a-4c8e-b6d0-9a5f2c1e8b73",
      "name": "Casey Park",
      "email": "casey@acme.com",
      "role": "member",
      "avatarUrl": null
    }
  ]
}
```

## Response Fields

Responds `200` with:

| Field | Type | Description |
| ----- | ---- | ----------- |
| `people` | Array | List of MentionPerson, fields below. |
| `people[].id` | String | Write a mention as `@[Name](user:<id>)`. |
| `people[].name` | String | Can be `null`. |
| `people[].email` | String | Shown to owners, admins, members and API keys, never to reviewers. Can be `null`. |
| `people[].role` | String | One of `owner`, `admin`, `member`, `reviewer`. |
| `people[].avatarUrl` | String | Can be `null`. |

## Error Responses

Every error has the same body: `error`, `code`, `message` and `helpUrl`, plus the fields that apply (`required`, `role`, `context`, `blockers`, `violations`, `issues`, `current`). Branch on `error`; `code` is more specific. See the [error reference](https://orshot.com/docs/error-reference).

| Status Code | Error | Description |
| ----------- | ----- | ----------- |
| 401 | `oauth_token_invalid` | The OAuth token is invalid, expired or revoked. |
| 403 | `api_key_missing` | No `Authorization: Bearer` header. |
| 403 | `permission_denied` | You don't have access to do this. Ask an owner or admin. `code` names the capability, for example `approval.item.decide_denied`; `required` and `role` say what was missing. With `code: insufficient_scope`: the OAuth token lacks `workspace:approvals:read`. With `code: approval.member_header_not_member`: `X-Orshot-User-Id` names someone who isn't an owner, admin or member of the workspace now. With `code: approval.member_header_not_allowed`: an OAuth token sent `X-Orshot-User-Id`. |
| 403 | `plan_required` | The workspace's plan doesn't include Approvals, or doesn't include this part of it. |
| 403 | `enterprise_api_required` | Using approvals with an API key needs an Enterprise plan. Contact hi@orshot.com to turn it on. |
| 404 | `not_found` | This doesn't exist or isn't available to you. Reviewers get this, never 403, for flows and templates outside their access. |
| 422 | `validation_failed` | Some fields aren't valid: the fields listed in issues. `issues` lists each field with a path and a reason. |
| 422 | `validation_failed` | With `code: approval.member_header_invalid`: `X-Orshot-User-Id` isn't a user id. |
| 429 | `rate_limit_exceeded` | More than 120 approvals requests in a minute from one person or key. Wait for Retry-After. |
| 503 | `approvals_unavailable` | Approvals aren't available right now. Try again in a moment. Also returned while approvals are not switched on for the API. |