Get workspace

Read the name, webhook URL and concurrency limit of the workspace the API key belongs to.

GEThttps://api.tried.com.au/workspace

Returns the workspace the API key belongs to. Any role can read it.

Request#

This endpoint takes no path, query or body parameters.

Example request#

curl https://api.tried.com.au/workspace \
  -H "Authorization: Bearer $TRIED_API_KEY"

const res = await fetch("https://api.tried.com.au/workspace", {
  headers: { Authorization: `Bearer ${process.env.TRIED_API_KEY}` },
});
const workspace = await res.json();

import os, requests

res = requests.get(
    "https://api.tried.com.au/workspace",
    headers={"Authorization": f"Bearer {os.environ['TRIED_API_KEY']}"},
)
workspace = res.json()

Response#

200 OK

{
  "workspace_id": "ws_3f9a1c7e5b2d4086a1c9e7f2",
  "name": "Harbour Dental",
  "webhook_url": "https://hooks.harbourdental.com.au/tried",
  "concurrency_limit": 20,
  "created_timestamp": 1758240000000
}

Field	Type	Description
`workspace_id`	string	Workspace ID, prefix `ws_`.
`name`	string	Workspace name. Also the text you type to confirm Delete workspace.
`webhook_url`	string or null	Account-level webhook URL. Call and chat events go here when the agent has no webhook URL of its own.
`concurrency_limit`	integer	Most calls the workspace can run at once. New workspaces start at 20. See Get concurrency.
`created_timestamp`	integer	Creation time, Unix ms.

Errors#

Status	When
`401`	Missing or invalid API key.
`403`	The key's IP allowlist or scopes reject the request. This route needs the `admin` scope.
`429`	Rate limit exceeded. See Rate limits.

See Errors for the body format.