members-access

List workspace groups

Changed on

Plan: Business or higher

Scope: workspaces:read

Returns the workspace's groups, sorted by name. Use a group's id as the id of a type "group" audience_targets entry when publishing a project with audience "custom" via POST or PATCH /v1/projects/{project_id}/publish.

get/v1/workspaces/{workspace_id}/groups

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.

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": [
    {
      "created_at": "2026-01-15T09:30:00Z",
      "description": "Platform and infrastructure engineers",
      "id": "engineering_workspace_01jw3k9m2xq8r5v0c7d4e6f2gh",
      "member_count": 12,
      "name": "Engineering",
      "scim_external_id": "00g1a2b3c4D5E6F7g8h9",
      "updated_at": "2026-01-15T09:30:00Z",
      "workspace_id": "workspace_01jw3k9m2xq8r5v0c7d4e6f2gh"
    }
  ],
  "pagination": {
    "has_more": true,
    "next_cursor": "eyJ2IjoxLCJpZCI6InByal8wMWp3M2s5In0"
  }
}

Changes

    • info

      for the header request parameter Lovable-Version, the format was generalized from date to no format

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status