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

get https://api.capmo.de/api/v1/projects/{projectId}/document-folders

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

Path Params

projectId

string

required

Query Params

order_direction

string

Defaults to asc

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

after

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.

limit

number

1 to 1000

Defaults to 200

How many items should be in the output.

parent_folder_id

string

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

include_sub_folders

boolean

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

order_by

string

Defaults to created_at

The field to order the document folders by.

query

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

Request-Id

json

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

Language

Credentials

Header


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.capmo.de/api/v1/projects/projectId/document-folders \
3
     --header 'Request-Id: YOUR_REQUEST_ID' \
4
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200The project document folders have been successfully retrieved.

400Bad request, Invalid input

401Unauthorized

403Forbidden

404Object not found

409Conflict

500Internal server error