api reference

Groups

Group membership, role assignment, and data-source access allowlisting.

GET/api/groups

List groups in the org. Requires view_groups.

Response

[
  { "id": 1, "name": "Everyone", "type": "builtin", "permissions": ["view_query"], "created_at": "2026-01-01T00:00:00Z", "updated_at": "2026-01-01T00:00:00Z" }
]

POST/api/groups

Create a group. Requires manage_groups.

Request

{ "name": "Analysts", "permissions": ["view_query", "create_query"] }

GET/api/groups/{id}/members

List a group's members.

Response

[{ "id": 12, "name": "Jane Doe", "email": "[email protected]" }]

PUT/api/groups/{id}/data_source_access

Toggle whether this group is restricted to an explicit data-source allowlist (see POST .../data_sources to manage the list itself) or has unrestricted reach.

Request

{ "restricted": true }

Response

{ "ok": true, "restricted": true }