List Directories (POST) | DevRev

1 curl -X POST https://api.devrev.ai/directories.list \ 2 -H "Authorization: Bearer <token>" \ 3 -H "Content-Type: application/json" \ 4 -d '{}'

1 { 2 "directories": [ 3 { 4 "id": "foo", 5 "body": { 6 "id": "foo", 7 "display_id": "foo", 8 "file": { 9 "type": "foo", 10 "name": "foo", 11 "size": 42 12 } 13 }, 14 "created_by": { 15 "display_id": "foo", 16 "id": "foo", 17 "display_name": "foo", 18 "display_picture": { 19 "display_id": "foo", 20 "id": "foo", 21 "file": { 22 "type": "foo", 23 "name": "foo", 24 "size": 42 25 } 26 }, 27 "email": "foo", 28 "full_name": "foo", 29 "state": "active" 30 }, 31 "created_date": "2023-01-01T12:00:00.000Z", 32 "description": "foo", 33 "display_id": "foo", 34 "icon": "foo", 35 "modified_by": { 36 "display_id": "foo", 37 "id": "foo", 38 "display_name": "foo", 39 "display_picture": { 40 "display_id": "foo", 41 "id": "foo", 42 "file": { 43 "type": "foo", 44 "name": "foo", 45 "size": 42 46 } 47 }, 48 "email": "foo", 49 "full_name": "foo", 50 "state": "active" 51 }, 52 "modified_date": "2023-01-01T12:00:00.000Z", 53 "parent": { 54 "id": "foo", 55 "display_id": "foo" 56 }, 57 "published": true, 58 "rank": "foo", 59 "tags": [ 60 { 61 "tag": { 62 "id": "foo", 63 "name": "foo", 64 "display_id": "foo" 65 }, 66 "value": "foo" 67 } 68 ], 69 "thumbnail": { 70 "id": "foo", 71 "display_id": "foo", 72 "file": { 73 "type": "foo", 74 "name": "foo", 75 "size": 42 76 } 77 }, 78 "title": "foo" 79 } 80 ], 81 "next_cursor": "foo", 82 "prev_cursor": "foo" 83 }

Lists directories matching the request.

Headers

AuthorizationstringRequired

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

Request

This endpoint expects an object.

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

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.

Headers

Request

Response

Errors