Workspace API

Access and manage workspace-level settings and information with the Workspace API endpoints.

---

Endpoints

1. List Workspaces

GET /v1/workspaces

• Description: Retrieve a list of workspaces.
• Authentication: Requires x-api-key header.

Query Parameters:

Name	In	Type	Required	Description
limit	query	string	No	Max number of results
page	query	string	No	Page number for pagination
searchText	query	string	No	Free text search
x-api-key	header	string	Yes	API authentication key

Response: [200 OK] - Array of Workspace

---

2. Get Workspace by ID

GET /v1/workspaces/{workspaceId}

• Description: Retrieve a workspace by its unique ID.
• Authentication: Requires x-api-key header.

Path Parameters:

Name	In	Type	Required	Description
workspaceId	path	string	Yes	Workspace unique ID
x-api-key	header	string	Yes	API authentication key

Response: [200 OK] - Workspace

---

Schemas

Workspace Schema

{
  "id": "string",
  "title": "string"
}

Workspaces Schema

[
  { /* Workspace object */ }
]