Skip to main content
GET
List workspace items
List the items in a deployment’s workspace — folders, workbooks, and reports — in a single unified, paginated feed. By default this returns the items at the workspace root. Pass folderId to list the contents of a specific folder instead. Folders are always returned ahead of other item types so they render at the top of a listing. Supported query parameters:
  • folderId — list the contents of this folder (omit for the root).
  • types — restrict the results to one or more item types (FOLDER, WORKBOOK, REPORT). Repeat the parameter to pass several.
  • search — case-insensitive substring match on item names; searches across all folders, not just the current level.
  • orderByField / orderByDirection — sort the non-folder items (e.g. by name, updated_at, created_at, or viewer_last_viewed_at).
  • first / after — cursor-based pagination.
Results are scoped to the calling user: only items the user can access are returned.

Authorizations

Authorization
string
header
required

Token authentication. Send Authorization: Bearer <YOUR_TOKEN>.

Path Parameters

deploymentId
number
required

Query Parameters

folderId
integer | null
types
enum<string>[] | null
Available options:
FOLDER,
WORKBOOK,
REPORT
orderByField
enum<string> | null
Available options:
updated_at,
created_at,
name,
viewer_last_viewed_at
orderByDirection
enum<string> | null
Available options:
ASC,
DESC
search
string | null
after
string
first
integer
Required range: x >= 1

Response

200 - application/json
items
object[]
required
pageInfo
object
required