Skip to main content
GET
/
spaces
TypeScript SDK
import { Orchata } from '@orchata/sdk';

const client = new Orchata({ apiKey: 'oai_your_api_key' });

const { spaces, total } = await client.spaces.list();
{
  "spaces": [
    {
      "id": "<string>",
      "orgId": "<string>",
      "name": "<string>",
      "slug": "<string>",
      "icon": "folder",
      "description": "<string>",
      "isArchived": true,
      "archivedAt": "2023-12-25",
      "createdAt": "2023-12-25",
      "updatedAt": "2023-12-25"
    }
  ],
  "total": 123,
  "page": 123,
  "pageSize": 123,
  "totalPages": 123
}

Authorizations

Oai-Api-Key
string
header
required

Query Parameters

page
number
default:1
Required range: x >= 1
pageSize
number
default:20
Required range: 1 <= x <= 100
status
enum<string>
default:active
Available options:
active,
archived,
all

Response

Successfully retrieved spaces

spaces
object[]
required
total
number
required
page
number
required
pageSize
number
required
totalPages
number
required