API Reference

/api/v1/projects/{projectId}/plans

get
https://api.capmo.de/api/v1/projects//plans

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

Path Params
string
required
Query Params
string
Defaults to server_created_at

Field to order by. It can be any field of the entity.

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
enum

Which type of file to return for each plan: PDF, or CAD for DWG and DXF files. A plan without a file of the requested type returns its latest file of the other type.
When omitted, each plan's latest PDF file is returned, and plans without a PDF file are left out.

Allowed:
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 5 months ago

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

Updated 5 months ago

Did this page help you?