Skip to main content

Workspaces API

Manage the collaborative workspaces where you and your team organize resources.

List Workspaces​

List all workspaces you own or are a member of.

Request

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

Response

{
  "owned_workspaces": [
    {
      "id": "78047707-5f8f-472b-a065-3d3dc48ba80a",
      "name": "Production Workspace",
      "owner_id": "21",
      "active_plan_id": null,
      "created_at": "2026-01-01T19:11:55.889Z",
      "is_active": true,
      "member_count": 5
    }
  ],
  "member_workspaces": []
}

Create Workspace​

Create a new workspace.

Request

curl -X POST https://api.syauth.com/e/v1/developer/workspaces/ \
  -H "X-Developer-Token: syat_..." \
  -H "Content-Type: application/json" \
  -d '{"name": "New Project Workspace"}'

Response

{
  "id": "4d80bcc3-1700-44ac-a440-636441b72557",
  "name": "New Project Workspace",
  "owner_id": "21",
  "active_plan_id": null,
  "created_at": "2026-01-04T20:12:35.123Z",
  "updated_at": "2026-01-04T20:12:35.123Z",
  "is_active": true,
  "member_count": 1
}

Get Workspace Details​

Retrieve detailed information about a specific workspace.

Request

curl -X GET https://api.syauth.com/e/v1/developer/workspaces/78047707-5f8f-472b-a065-3d3dc48ba80a/ \
  -H "X-Developer-Token: syat_..."

Response

{
  "id": "78047707-5f8f-472b-a065-3d3dc48ba80a",
  "name": "Production Workspace",
  "owner_id": "21",
  "active_plan_id": null,
  "created_at": "2026-01-01T19:11:55.889Z",
  "updated_at": "2026-01-01T19:11:55.889Z",
  "is_active": true,
  "member_count": 5
}

Update Workspace​

Update details of an existing workspace.

Request

curl -X PATCH https://api.syauth.com/e/v1/developer/workspaces/78047707-5f8f-472b-a065-3d3dc48ba80a/ \
  -H "X-Developer-Token: syat_..." \
  -H "Content-Type: application/json" \
  -d '{"name": "Updated Workspace Name"}'

Response

{
  "id": "78047707-5f8f-472b-a065-3d3dc48ba80a",
  "name": "Updated Workspace Name",
  "owner_id": "21",
  "active_plan_id": null,
  "created_at": "2026-01-01T19:11:55.889Z",
  "updated_at": "2026-01-07T10:00:00.123Z",
  "is_active": true,
  "member_count": 5
}

Delete Workspace​

Permanently delete a workspace and all its resources (clients, users, etc.).

Request

curl -X DELETE https://api.syauth.com/e/v1/developer/workspaces/4d80bcc3-1700-44ac-a440-636441b72557/ \
  -H "X-Developer-Token: syat_..."

Response 204 No Content