v1
latestOpenAPI 3.1.02026-08-0662251219.8 KBCompanies
List companies
This endpoint lists companies. If externalId is provided in query param, only the company having the specified external ID is returned.
get/v2/companies
Query parameters
externalIdstring
External id of the entity.
companyRoleCompanyRole[]
Filter by a particular role
[ "ORG" ]
companyIdsstring[]
Filter by a list of companies
contractingTmcIdsstring[]
Filter by contracting TMCs
bookingTmcIdsstring[]
Filter by booking TMCs
offsetinteger
Indicates the start index to read companies from the server.
limitinteger
Maximum number of results to be fetched.
Response
OK
Example response
{
"elements": [
{
"id": "b93dc51f-12dd-46c7-b7d6-1cb12cd3f5b3",
"name": "Name"
}
]
}