v1
latestOpenAPI 3.0.12026-07-144840447.2 KBCompanies
List companies
This endpoint returns a list of companies related to the firm.
ℹ️ This endpoint requires the following scope: companies:readonly
get/api/external/firm/v1/companies
Query parameters
pageinteger
Example:1
Items are paginated, this is the current page which will be returned. The page index is starting at 1.
per_pageinteger
Example:20
Items are paginated. By default, you get 20 items per page. You can specify another number of items per page.
filterstring
Example:[{"field": "client_code", "operator": "eq", "value": "42"}]
You can choose to filter items on specific fields. Available fields and values:
- client_code: eq, not_eq, in, not_in
Response
Returns a list of companies related to the firm the access token is associated with.
Example response
{
"items": [
{
"id": 22938,
"name": "Koss Inc.",
"billing_company_name": "Koss",
"siren": "362521879",
"address": "35508 Mary Plain",
"city": "Jefferson City",
"postal_code": "77379",
"activity_nomenclature": "NAFRev2",
"activity_code": "1234A",
"external_id": "G6YYYLPXIZ",
"client_code": "DOSSIER_ABC"
}
],
"total_pages": 5,
"current_page": 1,
"total_items": 12,
"per_page": 40
}