/api/v1/organisation/companies

get https://api.capmo.de/api/v1/organisation/companies

This can be used to list all organisation contact book companies in a paginated response.

Query Params

order_by

string

Defaults to server_created_at

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

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.

source_id

string

length ≤ 255

[Filtering Parameter] The unique identifier of the source. This is a user-generated string, used to link the company to a resource in an external system.

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/organisation/companies \
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 organisation contact book companies have been successfully retrieved.

400Bad request, Invalid input

401Unauthorized

403Forbidden

404Object not found

409Conflict

500Internal server error