Nuclino · Example Payload

List Workspaces

List all workspaces for a team with cursor-based pagination

Knowledge ManagementTeam WorkspaceDocumentationWikiCollaborationProject ManagementREST API

List Workspaces is an example object payload from Nuclino, with 3 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

descriptionrequestresponse

Example Payload

Raw ↑ 
{
  "description": "List all workspaces for a team with cursor-based pagination",
  "request": {
    "method": "GET",
    "url": "https://api.nuclino.com/v0/workspaces?teamId=t1b2c3d4-e5f6-7890-abcd-ef1234567890&limit=5",
    "headers": {
      "Authorization": "YOUR_API_KEY"
    }
  },
  "response": {
    "status": 200,
    "body": {
      "status": "success",
      "data": {
        "object": "list",
        "items": [
          {
            "object": "workspace",
            "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
            "teamId": "t1b2c3d4-e5f6-7890-abcd-ef1234567890",
            "name": "Engineering",
            "createdAt": "2023-06-01T08:00:00.000Z",
            "createdUserId": "u1b2c3d4-e5f6-7890-abcd-ef1234567890",
            "fields": [],
            "childIds": [
              "3c9b6b5a-1f2e-4b3a-8d9c-0e1f2a3b4c5d"
            ]
          },
          {
            "object": "workspace",
            "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
            "teamId": "t1b2c3d4-e5f6-7890-abcd-ef1234567890",
            "name": "Product",
            "createdAt": "2023-06-01T08:05:00.000Z",
            "createdUserId": "u1b2c3d4-e5f6-7890-abcd-ef1234567890",
            "fields": [],
            "childIds": []
          }
        ]
      }
    }
  }
}