# List colleagues

List active colleagues with their account IDs, display names and base roles. Email addresses are excluded; administrators can use workspace.ListMembers for the detailed roster.

POST https://api.brigg.app/v1/operations/workspace.ListColleagues

## Access & visibility

Allow `workspace.ListColleagues` on your API key.

**Workspace access by default.** Private member data requires [approved member delegation](https://developer.brigg.app/authentication#member-delegation) through `Brigg-Act-As`; the key supplies permissions while private ownership and project boundaries remain enforced.

[Set up authentication](https://developer.brigg.app/authentication) · [Choose permissions](https://developer.brigg.app/permissions)

## Request

No parameters. Send an empty JSON object (`{}`).

## Response

Returns **200 OK** with a JSON body.

This operation has no continuation cursor. An empty `items` array means no matching visible results were returned.

This is the active colleague roster for members with workspace access; chat-only guests cannot read it. Use account IDs for approved member delegation, not customer Person record IDs. Listing a colleague never grants the key authority to act as them.
| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `items` | array of [Colleague](#colleague-response-items) | Yes | Workspace colleagues with their account IDs and display names. This operation has no cursor pagination. |

### Colleague · response.items[]

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | Yes | Workspace member's account ID, which can be used with Brigg-Act-As only if this key's delegation grant permits that member. |
| `name` | string | Yes | Member's display name. |
| `role` | string | Yes | Base role ID, such as owner, admin or member, or a workspace-defined role ID. It is not a localized label or a complete list of additive permissions. Resolve labels with workspace.ListRoles. |

## Errors & retries

This operation reads data. It needs no idempotency key and can be retried after a transient failure.

For rate limits, follow the server’s retry guidance and back off. See [HTTP errors](https://developer.brigg.app/http#errors) and [safe retries and limits](https://developer.brigg.app/reliability).

| HTTP status | Code | What to do |
| --- | --- | --- |
| 400 | `invalid_json` | Send a JSON object with Content-Type: application/json. |
| 400 | `invalid_input` | Check the request fields and types. |
| 401 | `invalid_key` | The workspace API key is missing, invalid or revoked. |
| 403 | `forbidden` | Check the key’s operation and resource grants. If Brigg-Act-As is supplied, the key must be authorized to delegate to that member. |
| 404 | `not_found` | The requested operation or resource is not available to this credential. |
| 429 | `rate_limited` | Wait for Retry-After before retrying. |

## Next steps

- [List roles](https://developer.brigg.app/reference/workspace/ListRoles)
- [List members](https://developer.brigg.app/reference/workspace/ListMembers)

[Download OpenAPI](https://developer.brigg.app/openapi.json) · [Versioning & retirement](https://developer.brigg.app/versioning)

## Examples

### Example request

Fictional values. Replace IDs and business details with values from your workspace.
#### cURL


```sh
curl 'https://api.brigg.app/v1/operations/workspace.ListColleagues' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  --data-raw '{}'
```

#### TypeScript


```typescript
const response = await fetch("https://api.brigg.app/v1/operations/workspace.ListColleagues", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BRIGG_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({}),
});
const result = await response.json();
if (!response.ok) throw new Error(`${response.status}: ${result.error} — ${result.message}`);
console.log(result);
```

#### Python


```python
import json
import os
from urllib.request import Request, urlopen
from urllib.error import HTTPError

payload = {}
request = Request(
    "https://api.brigg.app/v1/operations/workspace.ListColleagues",
    data=json.dumps(payload).encode("utf-8"),
    headers={
        "Authorization": f"Bearer {os.environ['BRIGG_API_KEY']}",
        "Content-Type": "application/json",
    },
    method="POST",
)
try:
    with urlopen(request) as response:
        print(json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))
    raise
```

#### Response example


```json
{
  "items": [
    {
      "id": "account_alex",
      "name": "Alex Morgan",
      "role": "member"
    }
  ]
}
```

## JSON schemas


```json-schema-request
{
  "type": "object",
  "properties": {},
  "additionalProperties": false,
  "examples": [
    {}
  ]
}
```


```json-schema-response
{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Workspace member's account ID, which can be used with Brigg-Act-As only if this key's delegation grant permits that member.",
            "examples": [
              "account_alex"
            ]
          },
          "name": {
            "type": "string",
            "description": "Member's display name.",
            "examples": [
              "Alex Morgan"
            ]
          },
          "role": {
            "type": "string",
            "description": "Base role ID, such as owner, admin or member, or a workspace-defined role ID. It is not a localized label or a complete list of additive permissions. Resolve labels with workspace.ListRoles.",
            "examples": [
              "member"
            ]
          }
        },
        "required": [
          "id",
          "name",
          "role"
        ],
        "additionalProperties": false,
        "title": "Colleague"
      },
      "description": "Workspace colleagues with their account IDs and display names. This operation has no cursor pagination."
    }
  },
  "required": [
    "items"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "items": [
        {
          "id": "account_alex",
          "name": "Alex Morgan",
          "role": "member"
        }
      ]
    }
  ]
}
```