For the complete documentation index, see llms.txt. This page is also available as Markdown.

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. 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.

GET https://app.flora.ai/api/v1/workspaces/{workspaceId}/members
  • Auth: API key as a bearer token, Authorization: Bearer $FLORA_API_KEY. See Authentication.

  • TypeScript SDK: client.workspaces.listMembers(), paginated. See Pagination.

  • Operation ID: listWorkspaceMembers.

Example

curl -X GET 'https://app.flora.ai/api/v1/workspaces/ws_abc123/members' \
  -H "Authorization: Bearer $FLORA_API_KEY"
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);
}

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.

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: [email protected].

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 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.

Last updated

Was this helpful?