Directories List Post

POST

Lists directories matching the request.

Request

This endpoint expects an object.
created_bylist of stringsOptional

Filters for directories created by any of the provided users.

cursorstringOptional

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’.

mode"after" or "before"Optional
Allowed values: afterbefore

The iteration mode to use. If “after”, then entries after the provided cursor will be returned, or if no cursor is provided, then from the beginning. If “before”, then entries before the provided cursor will be returned, or if no cursor is provided, then from the end. Entries will always be returned in the specified sort-by order.

modified_bylist of stringsOptional

Filters for directories modified by any of the provided users.

Response

This endpoint returns an object.
directorieslist of objects

The list of directories.

next_cursorstringOptional

The cursor used to iterate subsequent results in accordance to the sort order. If not set, then no later elements exist.

prev_cursorstringOptional

The cursor used to iterate preceding results in accordance to the sort order. If not set, then no prior elements exist.