WayloAIWaylo Docs
APIReferenceWorkspaces

List workspaces

GET
/workspaces

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

Authorization

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

Query Parameters

page?number
Range1 <= value <= 10000
Default1
limit?number
Range1 <= value <= 100
Default25
orderDirection?string
Default"desc"
Value in"asc""desc"
externalId?string
Length1 <= length <= 255
timezone?string
Length1 <= length <= 255
createdByUserId?string
Formatuuid
updatedByUserId?string
Formatuuid
active?boolean
orderBy?string
Value in"name""externalId""timezone""createdByUserName""updatedByUserName""memberCount""active""createdAt""updatedAt"
search?string

Free-text search over the searchBy fields.

Length1 <= length <= 255
searchBy?string

Comma-separated: name.

Header Parameters

Authorization*string

Your API key.

Response Body

Success

application/json
  1. response
[index: integer]?
Example Request
curl -X GET 'https://api.poc.app.waylovoice.ai/workspaces' \  -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"  }]

Get workspace GET

A single workspace by id, for any member who can reach it. **Access:** tenant_member · API key `workspaces:read`

Update workspace PATCH

Change any part of a workspace, including retiring it with `active: false` and the way back. It never moves between tenants. A `metadata` sent here replaces the stored object whole rather than merging into it. **Access:** tenant_admin · API key `workspaces:write`