v1

latestOpenAPI 3.1.02026-07-24172151607.6 KB
Docs

Search for Docs

View the Docs in your Workspace. You can only view information of Docs you can access.

get/api/v3/workspaces/{workspace_id}/docs

Path parameters

workspace_idnumber required

The ID of the Workspace.

Query parameters

idstring

Filter results to Docs created by the user with the given Doc ID.

creatornumber

Filter results to Docs created by the user with the given user ID.

deletedboolean

Filter results to return deleted Docs.

archivedboolean

Filter results to return archived Docs.

parent_idstring

Filter results to children of a parent Doc with the given parent Doc ID.

parent_type'4' | '5' | '6' | '7' | '12' | 'SPACE' | 'FOLDER' | 'LIST' | 'EVERYTHING' | 'WORKSPACE'

Filter results to children of the given parent Doc type. For example, SPACE, FOLDER, LIST, EVERYTHING, WORKSPACE.

limitnumber

The maximum number of results to fetch for this page.

cursorstring

The cursor to use to fetch the next page of results.

next_cursorstring

The cursor to use to fetch the next page of results. [deprecated]

Response

Search results

next_cursorstring