List workspace members

GET

/workspaces/{workspaceId}/members

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: '<workspaceId>',
})) {
  console.log(workspace);
}

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.

Error responses use the standard error body.

Authorizations

• bearerAuth

Parameters

Path Parameters

workspaceId

required

Workspace identifier

string

/^ws_\S+$/

Workspace identifier

Query Parameters

limit

Maximum number of results to return

integer

>= 1 <= 100

Maximum number of results to return

cursor

Opaque cursor for fetching the next page

string

Opaque cursor for fetching the next page

Responses

200

Workspace members returned.

Media type application/json

object

workspace_id

required

Workspace identifier

string

/^ws_\S+$/

members

required

Array<object>

object

email

required

Member email address

string

name

required

Any of:

string

string

null

null

role

required

Workspace role

string

joined_at

required

Any of:

integer

integer

null

null

meta

required

object

next_cursor

required

Any of:

string

Opaque cursor for fetching the next page

string

null

null

total_estimate

Any of:

integer

Estimated total matching items

integer

null

null

Example

{
  "workspace_id": "ws_abc123",
  "members": [
    {
      "email": "[email protected]"
    }
  ],
  "meta": {
    "next_cursor": "eyJvZmZzZXQiOjIwfQ"
  }
}