List workspace documents

Retrieves all documents within the specified workspace, including workbooks, dashboards, and other content files.

GET/organizations/{organizationName}/workspaces/{workspaceName}/documents

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

organizationName*string

The unique identifier of the organization

Match^[a-zA-Z0-9_ -]+$

workspaceName*string

The unique identifier of the workspace

Match^(?!.*\*)(?!.*[/]).{1,63}$

Query Parameters

retrieveContent?boolean

If true, include the document content in the response. Defaults to false.

Defaultfalse

Response Body

`application/json`

curl --request GET \  --url 'https://example.com/organizations/string/workspaces/string/documents' \  --header 'Authorization: Bearer <token>'

[  {    "path": "string",    "content": "string",    "type": "workbook",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "modifiedBy": "string",    "metadata": {}  }]

List workspace documents

Authorization

Path Parameters

Query Parameters

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`