List groups
⚠️
Preview — this feature is being built; the design below is the spec.
GET https://app.syntic.ai/v1/organizations/groupsReturn the organization’s groups.
For how this fits into a full workflow, see Groups and roles.
Headers
| Header | Required | Value |
|---|---|---|
Authorization | Yes | Bearer <admin key>: an Admin API key (sk_admin_...). Inference keys are refused with 403 admin_key_required. See Admin API keys. |
syntic-beta | Yes, while in preview | admin-2026-11-01. Without it the call fails with 400 beta_required. See Versioning. |
Query parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
source | string | manual or scim. | |
workspace_id | string | Groups holding a role in this workspace. | |
limit | integer | 20 | 1 to 100. |
after_id | string | Next page: the previous page’s last_id. | |
before_id | string | Previous page: the previous page’s first_id. |
Response
200 OK, Content-Type: application/json
{
"data": [
{
"id": "grp_01JCM0N2Q4S6U8W0Y2A4",
"type": "group",
"name": "data-science",
"description": "Analysts and ML engineers",
"source": "manual",
"workspace_roles": [
{
"workspace_id": "wrkspc_01JC0A2C4E6G8J0L2N4Q",
"role": "workspace_developer"
}
],
"member_count": 12,
"created_at": "2026-09-01T10:00:00Z",
"updated_at": "2026-11-01T10:00:00Z"
}
],
"has_more": false,
"first_id": "grp_01JCM0N2Q4S6U8W0Y2A4",
"last_id": "grp_01JCM0N2Q4S6U8W0Y2A4"
}| Field | Type | Description |
|---|---|---|
data | array | The objects on this page, newest first. |
has_more | boolean | true when another page exists after this one. |
first_id | string or null | Pass as before_id to go back a page. |
last_id | string or null | Pass as after_id to get the next page. |
Examples
curl -sS "https://app.syntic.ai/v1/organizations/groups" \
-H "Authorization: Bearer $SYNTIC_ADMIN_KEY" \
-H "syntic-beta: admin-2026-11-01"Errors
Errors use the error envelope and carry a request_id. Codes specific to this operation:
| Status | type | code | When |
|---|---|---|---|
| 400 | invalid_request_error | beta_required | The syntic-beta header is missing. |
| 401 | authentication_error | invalid_api_key | The admin key is missing, unknown, revoked or expired. |
| 403 | permission_error | admin_key_required | An inference key was used. |
| 429 | rate_limit_error | rate_limited | Too many requests; wait for Retry-After. See Rate-limit headers. |
Was this page helpful?