Skip to main content
GET
/
workspaces
List Workspaces
curl --request GET \
  --url https://api.raydocs.com/workspaces \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": 123,
      "name": "<string>",
      "icon": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ]
}

​
Authentication & Scope

Requires the workspaces-read ability.

​
Request

GET /workspaces HTTP/1.1
Host: api.raydocs.com
Authorization: Bearer <token>
No query parameters are supported.

​
Response

200 OK – An array of Workspace objects. 
[
  {
    "id": 1,
    "name": "My Workspace",
    "icon": "📊",
    "settings": {},
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-15T10:30:00Z"
  }
]
403 Forbidden – The token lacks workspaces-read or you do not have the necessary permissions.

Authorizations

​
Authorization
string
header
required

Personal Access Token created from the Raydocs dashboard. Include in the Authorization header: Bearer <your_token> See API Keys for token creation and management.

Response

Successful

​
data
object[]