Get a workspace
Workspace overview, name, slug, and counts of agents, members, and phone numbers. A workspace-level health glance.
Authorization
bearerAuth A personal access token from Settings > API tokens.
In: header
Path Parameters
Workspace slug (GET /me lists yours).
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X GET "https://example.com/workspaces/string"{
"workspace": "string",
"id": "string",
"name": "string",
"property1": null,
"property2": null
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}Who the token belongs to, and its workspaces GET
Show the authenticated user (email), the workspaces this token can access (slug + name + role), the workspace the token is pinned to if it is pinned to one, and the total tool count. Use the workspace slugs here to address agents as 'workspace-slug/agent-slug', then list_agents to see what's in each.
Archive an agent DELETE
Archive this agent. A reversible soft-delete that hides it from the workspace agents list and takes the agent off the phone. Archiving unassigns the agent's phone number. The agent stops taking new calls shortly afterwards, not the moment you confirm. The number stays in the workspace as a spare and is NOT released to the provider. Calls already in flight aren't affected, and the agent stays reachable by URL. If the unassign after the archive fails, the agent stays archived and the result says what is still routed to it. Reverse it with `restore_agent`, which does not re-assign the number: point it back with `assign_phone_number`. To remove an agent for good (irreversible), use `permanent_delete_agent` instead.