---
title: "List surfaces in a workspace"
method: GET
path: "/api/workspaces/{slug}/surfaces"
tags: ["Surfaces"]
---

# List surfaces in a workspace

`GET /api/workspaces/{slug}/surfaces`

## Request

- Base URL: `https://trydock.ai`
- URL: `https://trydock.ai/api/workspaces/{slug}/surfaces`
- Auth: HTTP bearer

Returns every surface (tab) in the workspace, in tab order.

## Path parameters

- `slug` string, required

## Response `200`

Surface list.

- object
  - `surfaces` object[], required
    - `id` string, required
    - `slug` string, required
    - `name` string, required
    - `kind` 'table' | 'doc', required: Whether this tab is a typed-row table or a TipTap rich-text doc.
    - `position` integer, required: Tab order within the workspace, 0-indexed.
    - `columns` object[], nullable: Column schema for table surfaces. `null` on doc/html surfaces.
      - `key` string, required
      - `label` string, required
      - `type` 'text' | 'longtext' | 'number' | 'status' | 'person' | 'date' | 'url' | 'checkbox' | 'select', required
      - `position` integer, required
      - `width` integer
      - `hidden` boolean
      - `wrap` boolean
      - `description` string
      - `options` object[]
        - `value` string, required
        - `label` string, required
        - `color` string

## Other responses

- `403`: Caller can't access this workspace.

## Changes

- **2026-11-05** `dd96ae96a412`: 1 info
  - added the optional property `surfaces/items/columns/items/wrap` to the response with the `200` status
- **2026-11-05** `767beae124a8`: 1 breaking
  - the `surfaces/items/columns/items/description` response property's maxLength was increased from `280` to `4000` for the response status `200`

[Operation history](https://skmtc.dev/trydock/apis/dock-rest-api/changes/api/workspaces/:slug/surfaces/get.md)

---

[API](https://skmtc.dev/trydock/apis/dock-rest-api.md) - [All operations](https://skmtc.dev/trydock/apis/dock-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/trydock/apis/dock-rest-api/revisions/dd96ae96a412?raw)