GET /folders

List all folders the authenticated user is a member of.

List the folders the authenticated user can access. Use the returned id values in folderIds when you want generated output stored in a specific folder.

List folders

get

Lists all folders the authenticated user is a member of within the workspace.

Authorizations
X-API-KEYstringRequired

API key for authentication

Query parameters
querystringOptional

Search query to filter folders by name

Example: marketing
limitnumber · min: 1 · max: 50Optional

Maximum results to return

Example: 20
afterstringOptional

Pagination cursor from previous response

Example: eyJpZCI6IjEyMyJ9
Responses
chevron-right
200

Folders retrieved successfully

application/json
hasMorebooleanRequired

Whether more results are available

Example: true
nextCursorstring · nullableOptional

Cursor for next page, null if no more results

Example: eyJpZCI6IjQ1NiJ9
get
/v1.0/folders
circle-info

For guidance on when to fetch folder IDs and how to use them in requests, see Use themes and folders.

Last updated

Was this helpful?