WayloAIWaylo Docs
APIReferenceWorkspaces

Get workspace

GET
/workspaces/{id}

A single workspace by id, for any member who can reach it.

Access: tenant_member · API key workspaces:read

Authorization

api-key
headerAuthorizationBearer <sk_waylo_<lookup><secret><checksum>>

Path Parameters

id*string

Header Parameters

Authorization*string

Your API key.

Response Body

Success

application/json
  1. response
id*string
name*string
externalId*string|null
timezone*string|null
metadata*
active*boolean
memberCount*number
createdByUserId*|
Formatuuid
createdByUserName*string|null
updatedByUserId*|
Formatuuid
updatedByUserName*string|null
createdAt*string
Formatdate-time
updatedAt*string
Formatdate-time
Example Request
curl -X GET 'https://api.poc.app.waylovoice.ai/workspaces/string' \  -H 'Authorization: Bearer sk_waylo_...'
Example Response
{  "id": "string",  "name": "string",  "externalId": "string",  "timezone": "string",  "metadata": {},  "active": true,  "memberCount": 0,  "createdByUserId": "4d2aef9a-17b0-44e6-902e-616812033620",  "createdByUserName": "string",  "updatedByUserId": "b38eaad7-8efa-49e7-b0aa-619916a3821e",  "updatedByUserName": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Create workspace POST

Open a workspace in the tenant. It is active from the start. **Access:** tenant_admin · API key `workspaces:write`

List workspaces GET

Workspaces a tenant owner or admin holds, and only the assigned ones for anybody else, offset-paginated. `web` needs this before it can scope any other screen. **Access:** tenant_member · API key `workspaces:read`