List your client workspaces
Paginate your clients' workspaces.
Returns your workspaces, a page at a time, newest first. Paused (archived) workspaces are left out unless you send include_archived=true. Deleted workspaces are left out unless you send include_deleted=true. The two switches are independent: a workspace that is both paused and deleted appears only when both are true.
Route
Query parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
| page | integer | No | 1 | Page number, starting at 1. |
| page_size | integer | No | 25 | Items per page, between 1 and 100. |
| include_archived | boolean | No | false | true returns paused workspaces alongside the others. |
| include_deleted | boolean | No | false | true returns deleted workspaces alongside the others. Each item then carries deleted_at, null for a workspace that is not deleted. |
Example request
curl "https://api.getsillage.com/api/v3/partner/workspaces?page=1&page_size=25&include_deleted=true" \
-H "Authorization: Bearer $SILLAGE_MASTER_KEY"Success response
Status: 200 OK
{
"data": [
{
"partner_workspace_id": "crm-4821",
"name": "Acme",
"domain": "acme.com",
"archived": false,
"created_at": "2026-10-16T09:00:00.000Z",
"deleted_at": null
}
],
"meta": {
"pagination": {
"page": 1,
"page_size": 25,
"page_count": 1,
"total": 1
}
}
}Response fields
| Field | Type | Description |
|---|---|---|
| data[] | array | The workspaces of the page. |
| meta.pagination | object | Pagination metadata: page, page_size, page_count and total. See Pagination. |
Each item of data has the fields of Get a client workspace, plus deleted_at (ISO 8601 date and time, or null) when you send include_deleted=true. Without it, deleted_at is absent.
Errors
| Status | Meaning |
|---|---|
| 401 | The master key is missing or invalid. |
| 422 | page, page_size, include_archived or include_deleted is not valid (Invalid query parameters), or a query parameter the route does not accept is sent. errors names each parameter. |
| 429 | Rate limit exceeded. |
| 500 | An unexpected server error occurred. |
Error responses use RFC 9457 problem documents with Content-Type: application/problem+json. type is always about:blank; code tells one problem from another, detail says what went wrong this time, and errors names the field at fault.