Workspaces

Workspaces

List all workspaces for an organization

get

Authorizations

apiAuth

Path parameters

organizationIdstring · uuidRequired

ID of the organization

Query parameters

per_pageintegerOptional

Number of workspaces per page

Default: 15

pageintegerOptional

Page number for pagination

Default: 1

Responses

200

List of workspaces

application/json

404

Organization not found

application/json

get

/api/organizations/{organizationId}/workspaces

HTTPcURLJavaScriptPython

GET /api/organizations/{organizationId}/workspaces HTTP/1.1
Host: 
Accept: */*

{
  "success": true,
  "message": "Workspaces retrieved successfully for organization",
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "organizationId": "123e4567-e89b-12d3-a456-426614174000",
      "name": "Workspace Name",
      "description": "Workspace Description",
      "status": "active",
      "createdAt": 1609459200,
      "updatedAt": 1609459200
    }
  ],
  "pagination": {
    "total": 1,
    "per_page": 1,
    "current_page": 1,
    "last_page": 1,
    "from": 1,
    "to": 1
  }
}

Create a new workspace for an organization

post

Authorizations

apiAuth

Path parameters

organizationIdstring · uuidRequired

ID of the organization

Body

application/json

namestringRequired

Name of the workspace

Example: Workspace Name

descriptionstringRequired

Description of the workspace

Example: Workspace description.

Responses

200

Workspace created successfully for organization

application/json

400

Validation error

application/json

404

Organization not found

application/json

post

/api/organizations/{organizationId}/workspaces

HTTPcURLJavaScriptPython

POST /api/organizations/{organizationId}/workspaces HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 64

{
  "name": "Workspace Name",
  "description": "Workspace description."
}

{
  "success": true,
  "message": "Workspace created successfully for organization",
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "organizationId": "123e4567-e89b-12d3-a456-426614174000",
    "name": "Workspace Name",
    "description": "Workspace Description",
    "status": "active",
    "createdAt": 1609459200,
    "updatedAt": 1609459200
  }
}

Get a specific workspace by its ID

get

Authorizations

apiAuth

Path parameters

organizationIdstring · uuidRequired

ID of the organization

workspaceIdstring · uuidRequired

ID of the workspace

Responses

200

Workspace retrieved successfully

application/json

404

Organization or Workspace not found

application/json

get

/api/organizations/{organizationId}/workspaces/{workspaceId}

HTTPcURLJavaScriptPython

GET /api/organizations/{organizationId}/workspaces/{workspaceId} HTTP/1.1
Host: 
Accept: */*

{
  "success": true,
  "message": "Workspace retrieved successfully",
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "organizationId": "123e4567-e89b-12d3-a456-426614174000",
    "name": "Workspace Name",
    "description": "Workspace Description",
    "status": "active",
    "createdAt": 1609459200,
    "updatedAt": 1609459200
  }
}

Delete a specific workspace

delete

Authorizations

apiAuth

Path parameters

organizationIdstring · uuidRequired

ID of the organization

workspaceIdstring · uuidRequired

ID of the workspace

Responses

204

Workspace deleted successfully

404

Workspace or Organization not found

application/json

delete

/api/organizations/{organizationId}/workspaces/{workspaceId}

HTTPcURLJavaScriptPython

DELETE /api/organizations/{organizationId}/workspaces/{workspaceId} HTTP/1.1
Host: 
Accept: */*

No content

Update an existing workspace for an organization

patch

Authorizations

apiAuth

Path parameters

organizationIdstring · uuidRequired

ID of the organization

workspaceIdstring · uuidRequired

ID of the workspace

Body

application/json

namestringOptional

Name of the workspace

Example: Updated Workspace Name

descriptionstring | nullableOptional

Description of the workspace

Example: Updated description of the workspace.

statusstringOptional

Status of the workspace (e.g., active, inactive)

Example: active

Responses

200

Workspace updated successfully

application/json

400

Validation error

application/json

404

Workspace or Organization not found

application/json

patch

/api/organizations/{organizationId}/workspaces/{workspaceId}

HTTPcURLJavaScriptPython

PATCH /api/organizations/{organizationId}/workspaces/{workspaceId} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 105

{
  "name": "Updated Workspace Name",
  "description": "Updated description of the workspace.",
  "status": "active"
}

{
  "success": true,
  "message": "Workspace updated successfully",
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "organizationId": "123e4567-e89b-12d3-a456-426614174000",
    "name": "Workspace Name",
    "description": "Workspace Description",
    "status": "active",
    "createdAt": 1609459200,
    "updatedAt": 1609459200
  }
}

Assign an agent to a workspace

get

Authorizations

apiAuth

Path parameters

organizationIdstring · uuidRequired

ID of the organization

workspaceIdstring · uuidRequired

ID of the workspace

Responses

200

Agent assigned successfully

application/json

400

Validation error

application/json

404

Workspace or Organization not found

application/json

get

/api/organizations/{organizationId}/workspaces/{workspaceId}/agents

HTTPcURLJavaScriptPython

GET /api/organizations/{organizationId}/workspaces/{workspaceId}/agents HTTP/1.1
Host: 
Accept: */*

{
  "success": true,
  "message": "Agent assigned successfully",
  "data": {
    "user_id": "user-uuid",
    "workspace_id": "workspace-uuid"
  }
}