Sign in

v1

latestOpenAPI 3.0.02026-07-2418630310.7 KB
Companies

List all companies

List all companies. <br> <b>Required scope(s):</b> administration:read

get/api/v4/f/{firm_id}/companies

Path parameters

firm_idinteger required

Query parameters

pageinteger
per_pageinteger
file_codestring

Headers

Acceptstring
Accept-Languagestring

Response

Successful response

idinteger

company_id

namestring
created_atstring
organisation_formstring
countrystring
citystring
streetstring
file_codestring
company_typestring
periods_per_yearinteger
sync_referencestring
accountancy_synchronisation_referencestring
accountancy_synchronisation_entity_idinteger
accountancy_synchronisation_entity_typestring
account_mapping_list_idinteger
administration_synchronisation_referencestring
administration_synchronisation_entity_idinteger
company_template_idinteger
folder_namestring
vatstring
visible_for_contributorsboolean
currencystring
group_idsinteger[]
year_endstring
first_namestring
last_namestring
national_insurance_numberstring