FLflorafauna-ai
Workspaces

List workspace members

Changed on

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.

get/workspaces/{workspaceId}/members

Request

  • Base URL
    https://app.flora.ai/api/v1
  • URL
    https://app.flora.ai/api/v1/workspaces/{workspaceId}/members
  • Auth
    HTTP bearer

Path parameters

workspaceIdstring required

Workspace identifier

Example:ws_abc123

Query parameters

limitinteger

Maximum number of results to return

cursorstring

Opaque cursor for fetching the next page

Example:eyJvZmZzZXQiOjIwfQ
emailstring email

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

Response

Workspace members returned.

workspace_idstring required

Workspace identifier

Example response

{
  "workspace_id": "ws_abc123",
  "members": [
    {
      "email": "ana@example.com"
    }
  ],
  "meta": {
    "next_cursor": "eyJvZmZzZXQiOjIwfQ"
  }
}

Changes

  • a12af1ff589cRevision changes
    • info

      added the new optional query request parameter email

  • a8351619f225Revision changes
    • warning

      added the new not_configured enum value to the / response property for the response status

    • warning

      added the new not_configured enum value to the / response property for the response status

    • warning

      added the new not_configured enum value to the / response property for the response status

    • warning

      added the new not_configured enum value to the / response property for the response status

    • warning

      added the new not_configured enum value to the / response property for the response status

    • warning

      added the new not_configured enum value to the / response property for the response status

    • warning

      added the new not_configured enum value to the / response property for the response status

    • warning

      added the new not_configured enum value to the / response property for the response status

    • warning

      added the new not_configured enum value to the / response property for the response status