Workspaces

Workspaces

List all workspaces for an organization

get
Authorizations
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
get
/api/organizations/{organizationId}/workspaces

Create a new workspace for an organization

post
Authorizations
Path parameters
organizationIdstring · uuidRequired

ID of the organization

Body
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
post
/api/organizations/{organizationId}/workspaces

Get a specific workspace by its ID

get
Authorizations
Path parameters
organizationIdstring · uuidRequired

ID of the organization

workspaceIdstring · uuidRequired

ID of the workspace

Responses
200

Workspace retrieved successfully

application/json
get
/api/organizations/{organizationId}/workspaces/{workspaceId}

Delete a specific workspace

delete
Authorizations
Path parameters
organizationIdstring · uuidRequired

ID of the organization

workspaceIdstring · uuidRequired

ID of the workspace

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

No content

Update an existing workspace for an organization

patch
Authorizations
Path parameters
organizationIdstring · uuidRequired

ID of the organization

workspaceIdstring · uuidRequired

ID of the workspace

Body
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
patch
/api/organizations/{organizationId}/workspaces/{workspaceId}

Assign an agent to a workspace

get
Authorizations
Path parameters
organizationIdstring · uuidRequired

ID of the organization

workspaceIdstring · uuidRequired

ID of the workspace

Responses
200

Agent assigned successfully

application/json
get
/api/organizations/{organizationId}/workspaces/{workspaceId}/agents

Last updated