Skip to content
BuildBase
HTTP API menu

List the company's groups

Needs the groups area at view.

GET/api/v1/public/workspaces/workspaceId/enterprise/groups

Sign-in
A signed-in user's session: send the session id in the x-session-id header.
Rate limit
Up to 500 requests every 3 seconds per IP address; up to 1,000 requests a minute per API key (some requests are not counted).

Needs the groups area at view. Each group with its people and what it gives.

Request

Path parameters

FieldTypeRequiredConstraintsDescription
workspaceIdstringYes--

Example request

Replace each YOUR_... value with your own, and set the credential in the environment variable the sample reads.

curl -X GET "https://api.console.buildbase.app/api/v1/public/workspaces/YOUR_WORKSPACE_ID/enterprise/groups" \
  -H "x-session-id: $BUILDBASE_SESSION_ID"
const response = await fetch(
  'https://api.console.buildbase.app/api/v1/public/workspaces/YOUR_WORKSPACE_ID/enterprise/groups',
  {
    method: 'GET',
    headers: {
      'x-session-id': process.env.BUILDBASE_SESSION_ID ?? '',
    },
  }
);
if (!response.ok) {
  throw new Error(`${response.status}: ${await response.text()}`);
}
const data = await response.json();
import os

import requests

response = requests.get(
    "https://api.console.buildbase.app/api/v1/public/workspaces/YOUR_WORKSPACE_ID/enterprise/groups",
    headers={
        "x-session-id": os.environ["BUILDBASE_SESSION_ID"],
    },
    timeout=30,
)
response.raise_for_status()
data = response.json()

Responses

200 OK

OK

Example
{
  "groups": [
    {
      "companyRole": null,
      "createdAt": "2026-01-01T00:00:00.000Z",
      "createdVia": "app",
      "description": "",
      "groupId": "000000000000000000000001",
      "includedIn": [],
      "includes": [],
      "inherited": [],
      "linked": [
        {
          "groupId": "Finance team",
          "source": "sso_group"
        }
      ],
      "managers": [],
      "members": [],
      "name": "Finance",
      "people": 1,
      "peopleBy": {
        "included": 0,
        "linked": 1,
        "named": 0
      },
      "rolesReached": [],
      "workos": null,
      "workspaces": [
        {
          "role": "editor",
          "workspaceId": "000000000000000000000002",
          "workspaceName": "Finance 1767225600000"
        }
      ]
    },
    {
      "companyRole": null,
      "createdAt": "2026-01-01T00:00:00.000Z",
      "createdVia": "app",
      "description": "",
      "groupId": "000000000000000000000003",
      "includedIn": [],
      "includes": [],
      "inherited": [],
      "linked": [],
      "managers": [],
      "members": [
        {
          "email": "[email protected]",
          "name": "Session User m12-cy",
          "userId": "000000000000000000000004"
        }
      ],
      "name": "Auditors",
      "people": 1,
      "peopleBy": {
        "included": 0,
        "linked": 0,
        "named": 1
      },
      "rolesReached": [],
      "workos": null,
      "workspaces": []
    },
    {
      "companyRole": null,
      "createdAt": "2026-01-01T00:00:00.000Z",
      "createdVia": "app",
      "description": "",
      "groupId": "000000000000000000000005",
      "includedIn": [],
      "includes": [],
      "inherited": [],
      "linked": [],
      "managers": [],
      "members": [
        {
          "email": "[email protected]",
          "name": "Session User m12-dee",
          "userId": "000000000000000000000006"
        }
      ],
      "name": "Support",
      "people": 1,
      "peopleBy": {
        "included": 0,
        "linked": 0,
        "named": 1
      },
      "rolesReached": [],
      "workos": null,
      "workspaces": []
    },
    {
      "companyRole": null,
      "createdAt": "2026-01-01T00:00:00.000Z",
      "createdVia": "app",
      "description": "",
      "groupId": "000000000000000000000007",
      "includedIn": [],
      "includes": [],
      "inherited": [],
      "linked": [],
      "managers": [],
      "members": [
        {
          "email": "[email protected]",
          "name": "Session User m12-dee",
          "userId": "000000000000000000000006"
        }
      ],
      "name": "From the API",
      "people": 1,
      "peopleBy": {
        "included": 0,
        "linked": 0,
        "named": 1
      },
      "rolesReached": [],
      "workos": null,
      "workspaces": []
    }
  ],
  "limits": {
    "depth": 3,
    "includes": 10,
    "managers": 10
  },
  "max": 50,
  "workspaces": [
    {
      "autoJoin": true,
      "name": "Design 1767225600000",
      "roles": ["admin", "editor", "viewer", "reviewer"],
      "workspaceId": "000000000000000000000008"
    },
    {
      "autoJoin": false,
      "name": "Finance 1767225600000",
      "roles": ["admin", "editor", "viewer", "reviewer"],
      "workspaceId": "000000000000000000000002"
    }
  ]
}

Any other status

Any other answer the handler sends itself (its own refusals). Not described yet.

Errors

Each refusal, what it means, and what to do. The request changed nothing.

401 Unauthorized

What it means: The credential is missing, expired or not accepted here, or the caller's role has no grant for x-permission (refused with 401 too). The body is the plain text Unauthorized, or a JSON body with a code where the gate says why.

What to do: Send the credential this operation asks for (see Sign-in above), or sign in again if it expired. A valid credential is also refused when the role has no grant for the permission above.

Example
Unauthorized

429 Too Many Requests

What it means: A rate limit in x-rateLimit was reached. retryAfter and the Retry-After header say how many seconds until the window resets.

What to do: Wait the number of seconds in the Retry-After header (also retryAfter in the body), then retry. Slow down repeated calls.

Example
{
  "success": false,
  "message": "string",
  "reason": "rate_limited",
  "retryAfter": 1
}