Skip to main content

Groups API

Manage user groups for access control and organization.

Create Group​

Create a new group in a workspace.

Request

curl -X POST https://api.syauth.com/e/v1/developer/groups/ \
  -H "X-Developer-Token: syat_..." \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Beta Testers",
    "description": "Users with access to beta features",
    "workspace": "78047707-5f8f-472b-a065-3d3dc48ba80a"
  }'

Response

{
  "id": "4e267feb-4409-4185-97cc-b34003aa1044",
  "name": "Beta Testers",
  "description": "Users with access to beta features",
  "workspace_id": "78047707-5f8f-472b-a065-3d3dc48ba80a",
  "member_count": 0,
  "created_at": "2026-01-07T10:15:00Z"
}

List Groups​

Request

curl -X GET https://api.syauth.com/e/v1/developer/groups/ \
  -H "X-Developer-Token: syat_..."

Response

[
  {
    "id": "4e267feb-4409-4185-97cc-b34003aa1044",
    "name": "Admin Group",
    "alias": "admins",
    "workspace_id": "78047707-5f8f-472b-a065-3d3dc48ba80a",
    "member_count": 3,
    "created_at": "2026-01-01T22:29:13.356Z"
  }
]

Get Group Details​

Request

curl -X GET https://api.syauth.com/e/v1/developer/groups/4e267feb-4409-4185-97cc-b34003aa1044/ \
  -H "X-Developer-Token: syat_..."

Response

{
  "id": "4e267feb-4409-4185-97cc-b34003aa1044",
  "name": "Beta Testers",
  "description": "Users with access to beta features",
  "workspace_id": "78047707-5f8f-472b-a065-3d3dc48ba80a",
  "member_count": 0,
  "created_at": "2026-01-07T10:15:00Z"
}

Update Group​

Update a group's name or description.

Request

curl -X PATCH https://api.syauth.com/e/v1/developer/groups/4e267feb-4409-4185-97cc-b34003aa1044/ \
  -H "X-Developer-Token: syat_..." \
  -H "Content-Type: application/json" \
  -d '{"description": "Updated description"}'

Response

{
  "id": "4e267feb-4409-4185-97cc-b34003aa1044",
  "name": "Beta Testers",
  "description": "Updated description",
  "workspace_id": "78047707-5f8f-472b-a065-3d3dc48ba80a",
  "member_count": 0,
  "created_at": "2026-01-07T10:15:00Z"
}

Delete Group​

Permanently delete a group.

Request

curl -X DELETE https://api.syauth.com/e/v1/developer/groups/4e267feb-4409-4185-97cc-b34003aa1044/ \
  -H "X-Developer-Token: syat_..."

Response 204 No Content