API ReferenceDirectory

List Directories

Lists directories matching the request.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

created_bylist of stringsOptional
Filters for directories created by any of the provided users.
cursorstringOptionalformat: "text"
The cursor to resume iteration from. If not provided, then iteration starts from the beginning.
limitintegerOptional
The maximum number of directories to return. The default is '50'.
modeenumOptional
The iteration mode to use, otherwise if not set, then "after" is used.
Allowed values:
modified_bylist of stringsOptional
Filters for directories modified by any of the provided users.

Response

List directory response.
directorieslist of objects
The list of directories.
next_cursorstring or nullformat: "text"
The cursor used to iterate subsequent results in accordance to the sort order. If not set, then no later elements exist.
prev_cursorstring or nullformat: "text"
The cursor used to iterate preceding results in accordance to the sort order. If not set, then no prior elements exist.

Errors