DOdovetail
Folders

Get folder contents

Changed on

Retrieve all items contained within a specific folder. Returns a paginated list of projects, docs, channels, dashboards, agents, and child folders that are direct children of the specified folder.

Each item includes its type, title, creation date, and author. Use this endpoint to browse a folder's contents or build a file-explorer-style navigation for your workspace.

Results can be sorted by creation date or title and are paginated.

🚧 Permissions

Please check you have the relevant permissions required to access this resource. This may include specific permissions on the object itself or its parent, or having the correct user role if you're making updates.

Required scope: folder:read or project:read

get/v1/folders/{folder_id}/contents

Request

  • Base URL
    https://dovetail.com/api
  • URL
    https://dovetail.com/api/v1/folders/{folder_id}/contents
  • Auth
    HTTP bearer

Path parameters

folder_idstring required

Unique identifier of the folder.

Query parameters

start_cursorstring
limitinteger nullable

See Pagination for details about how to use a cursor to iterate through the list.

'created_at:asc' | 'created_at:desc' | 'title:asc' | 'title:desc'
OR
string[]

See Sort for details on the sort parameter.

Response

200

Changes

  • 8abea327e6b9Revision changes
    • breaking

      added subschema #1 subschema #2 to the / response property oneOf list for the response status

    • breaking

      the / response's property type changed from object to no type for status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • warning

      removed the optional property // from the response with the status