> For the complete documentation index, see [llms.txt](https://docs.flora.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.flora.ai/api/reference/workspaces/listworkspacemembers.md).

# List workspace members

List workspace members with the FLORA API: GET /workspaces/{workspaceId}/members.

Returns one page of members for a workspace the authenticated credential can access — email, display name, and role for each. Use meta.next\_cursor to fetch subsequent pages, or pass email to look up one person. Lets an integration acting for the workspace (for example the FLORA Slack agent) tell which of the people it serves hold a FLORA account here. Workspaces the credential cannot read return 403.

```http
GET https://app.flora.ai/api/v1/workspaces/{workspaceId}/members
```

* **Auth:** API key as a bearer token, `Authorization: Bearer $FLORA_API_KEY`. See [Authentication](https://docs.flora.ai/api/platform/authentication.md).
* **TypeScript SDK:** `client.workspaces.listMembers()`, paginated. See [Pagination](https://docs.flora.ai/api/reference.md#pagination).
* **Operation ID:** `listWorkspaceMembers`.

## Example

{% tabs %}
{% tab title="cURL" %}

```bash
curl -X GET 'https://app.flora.ai/api/v1/workspaces/ws_abc123/members' \
  -H "Authorization: Bearer $FLORA_API_KEY"
```

{% endtab %}

{% tab title="TypeScript SDK" %}

```typescript
import { FloraClient } from '@flora-ai/flora';

const client = new FloraClient({ apiKey: process.env['FLORA_API_KEY'] });

// Paginated lists are async iterables; further pages are fetched as needed.
for await (const workspace of await client.workspaces.listMembers({
  workspaceId: 'ws_abc123',
})) {
  console.log(workspace);
}
```

{% endtab %}
{% endtabs %}

## Path parameters

| Name          | Type   | Required | Description                                                      |
| ------------- | ------ | -------- | ---------------------------------------------------------------- |
| `workspaceId` | string | Yes      | Workspace identifier. Pattern: `^ws_\S+$`. Example: `ws_abc123`. |

## Query parameters

| Name     | Type           | Required | Description                                                                                                                                                                                                                                                                                                                                                                                       |
| -------- | -------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `limit`  | integer        | No       | Maximum number of results to return. 1 to 100.                                                                                                                                                                                                                                                                                                                                                    |
| `cursor` | string         | No       | Opaque cursor for fetching the next page. Example: `eyJvZmZzZXQiOjIwfQ`.                                                                                                                                                                                                                                                                                                                          |
| `email`  | string (email) | No       | Return only the member who owns this email address, or no members when nobody who owns it belongs to the workspace. Matching ignores case for addresses stored in lowercase; an address stored with upper case matches only in that casing. At Gmail and Googlemail, dots in the local part are ignored. cursor and limit are ignored, and meta.next\_cursor is null. Example: `ana@example.com`. |

## Responses

### 200: Workspace members returned.

| Field                 | Type             | Required | Description                                                              |
| --------------------- | ---------------- | -------- | ------------------------------------------------------------------------ |
| `workspace_id`        | string           | Yes      | Workspace identifier. Pattern: `^ws_\S+$`. Example: `ws_abc123`.         |
| `members`             | array of objects | Yes      |                                                                          |
| `members[].email`     | string           | Yes      | Member email address. Example: `ana@example.com`.                        |
| `members[].name`      | string or null   | Yes      | Member display name, when set                                            |
| `members[].role`      | string           | Yes      | Workspace role                                                           |
| `members[].joined_at` | integer or null  | Yes      | When the membership was created (ms since epoch), when recorded          |
| `meta`                | object           | Yes      |                                                                          |
| `meta.next_cursor`    | string or null   | Yes      | Opaque cursor for fetching the next page. Example: `eyJvZmZzZXQiOjIwfQ`. |
| `meta.total_estimate` | integer or null  | No       | Estimated total matching items. At least 0.                              |

## Errors

Every error has the same body: `error.code`, `error.message`, and `error.fields` on validation errors. See [Errors](https://docs.flora.ai/api/platform/errors.md) for how to recover from each code.

| Status | Code                                         | Meaning                                                                             |
| ------ | -------------------------------------------- | ----------------------------------------------------------------------------------- |
| 400    | `invalid_json`, `input_validation_error`     | The body isn't valid JSON, or an input failed validation (`fields` lists each one). |
| 401    | `unauthorized`, `invalid_api_key`            | The API key is missing, invalid or revoked.                                         |
| 402    | `insufficient_credits`                       | The workspace balance is too low for this request.                                  |
| 403    | `forbidden`, `paid_plan_required`            | The key can't do this, or the workspace plan doesn't include it.                    |
| 404    | `not_found`                                  | The resource doesn't exist or isn't visible to this key.                            |
| 409    | `idempotency_duplicate`, `revision_conflict` | Duplicate `Idempotency-Key` or a stale `base_revision`.                             |
| 429    | `rate_limited`                               | Too many requests. Back off and retry.                                              |
| 500    | `unknown_error`, `internal_error`            | Something failed on FLORA's side. Retry with backoff.                               |
| 503    | `temporarily_unavailable`                    | Authorization is temporarily unavailable. Retry later.                              |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.flora.ai/api/reference/workspaces/listworkspacemembers.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
