members-access

List workspace members

Changed on

Plan: Business or higher

Scope: workspaces:read

Returns accepted workspace members with user_id, type, and name. The name is the stored display name, or null when unavailable. Filter with a repeated role, scim_managed=true|false, and query. Sort with sort_by plus sort_order; with a search query, results default to best matches first, otherwise they are ordered by role precedence, then most recently joined. Cursors are pinned to the filters and sort they were issued under; presenting one with different parameters returns 400. Reads are eventually consistent: recent changes may not appear immediately. Retry the read with backoff if an expected change is missing.

get/v1/workspaces/{workspace_id}/members

Request

  • Base URL
    https://api.lovable.dev
  • Auth
    • API key in header Lovable-API-Key
    • or HTTP bearer

Path parameters

workspace_idstring required

Workspace ID.

Example:workspace_01jw3k9m2xq8r5v0c7d4e6f2gh

Query parameters

limitinteger

Maximum number of items to return per page.

Example:50
cursorstring

Pass pagination.next_cursor from the previous response to fetch the next page. Omit for the first page; keep the same filters and sort order across pages.

querystring

Search by display name, username, or email. Terms shorter than 3 characters are ignored.

Example:jane
rolestring[]

Filter by the role returned in the response. The legacy values owner, admin, editor, member, viewer, and collaborator remain accepted aliases; member and editor both select workspace_editor. Repeat to match any of the values. Omit to include every role.

[
  "workspace_admin"
]
sort_by'name' | 'display_name' | 'joined_at' | 'role' | 'relevance'

Sort field. Omit for the default order: role precedence (workspace_owner, workspace_admin, workspace_editor, external_collaborator, workspace_viewer), then most recently joined; with query set, best matches first. name sorts case-insensitively by the returned name, with null names first ascending and last descending. display_name is an alias for name, with identical ordering and interchangeable cursors. joined_at falls back to the invitation time. role sorts by role precedence. relevance ranks by match score and requires query; ties break by most recent join. Other ties break by membership id.

Example:name
sort_order'asc' | 'desc'

Direction for sort_by. Defaults to descending. Requires sort_by.

Example:desc
scim_managedboolean

Filter by SCIM (System for Cross-domain Identity Management) provisioning: true returns only members provisioned by the identity provider, false only members added another way. Omit to include both.

Example:true

Headers

Lovable-Versionstring

Stable API version to serve, as a YYYY-MM-DD date. Omit for the oldest supported stable version, currently 2026-09-11.

Lovable-Betastring

Comma-separated beta revision strings to enable on top of the stable version.

Response

OK

Example response

{
  "data": [
    {
      "email": "jane.cooper@acme.com",
      "joined_at": "2026-01-15T09:30:00Z",
      "name": "Jane Cooper",
      "role": "workspace_admin",
      "type": "user",
      "user_id": "404666c6-b533-5d2c-9768-c425bf40559b"
    }
  ],
  "pagination": {
    "has_more": true,
    "next_cursor": "eyJ2IjoxLCJpZCI6InByal8wMWp3M2s5In0"
  }
}

Changes

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the enum value editor to the property items/ of the query request parameter role

    • info

      added the enum value external_collaborator to the property items/ of the query request parameter role

    • info

      added the enum value workspace_admin to the property items/ of the query request parameter role

    • info

      added the enum value workspace_editor to the property items/ of the query request parameter role

    • info

      added the enum value workspace_owner to the property items/ of the query request parameter role

    • info

      added the enum value workspace_viewer to the property items/ of the query request parameter role

    • info

      added the required property // to the response with the status