API v3 is live and in beta: expect possible malfunctions and breaking changes in the coming days. If you find a bug, please report it to your Sillage contact.

Get a client workspace

Retrieve one of your clients' workspaces.

Returns one of your workspaces. A deleted workspace is not found: restore it first.

Route

GET/api/v3/partner/workspaces/{partner_workspace_id}

Path parameters

ParameterTypeDescription
partner_workspace_idstringYour own ID for the client workspace, as you chose it at creation. URL-encode it in the path.

Example request

curl "https://api.getsillage.com/api/v3/partner/workspaces/crm-4821" \
  -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"
  }
}

Response fields

FieldTypeDescription
data.partner_workspace_idstringYour own ID for the client.
data.namestringName of the workspace.
data.domainstring or nullCompany domain of the client, in lowercase. null on some older workspaces.
data.archivedbooleantrue when the client is paused.
data.created_atstringISO 8601 date and time the workspace was created.

Errors

StatusMeaning
401The master key is missing or invalid.
404No workspace found for this partner_workspace_id.
422A query parameter is sent: this route takes none, and errors names the parameter.
429Rate limit exceeded.
500An 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.

On this page