API Reference

/api/v1/projects/{projectId}/document-folders

get
http://localhost:8000/api/v1/projects//document-folders

This can be used to list all project document folders in a paginated response.

Path Params
string
required
Query Params
string
enum
Defaults to asc

Order direction of the order_by field. It can be asc or desc.

Allowed:
string

The last element from the previous page. This is a cursor. It will be returned in the output to be used in the next request. When it is not present, the first page is returned. When it is null, there are no more pages.

number
1 to 1000
Defaults to 200

How many items should be in the output.

string

The unique identifier of the document folder's parent folder ID.

boolean

Whether the response should include all sub-folders or not.

string
Defaults to created_at

The field to order the document folders by.

string

Can be used to search for a document folder by a partial match on its name.

folder_ids
array of strings

Can be used to filter the results to a list of document folders IDs.

folder_ids
Headers
string

The HTTP Request-Id request header is an optional and unofficial HTTP header, used to trace individual HTTP requests from the client to the server and back again. It allows the client and server to correlate each HTTP request. If not provided by the client, the server should generate a unique request ID and include it in the response.

Responses

Updated about 2 months ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 months ago