List organisations
List all organisations for the current user
GET
/api/v1/{app_id}/organisationsAuthorization
AuthorizationAPI key · headerrequiredBearer token (format: "Bearer {token}")
Path parameters
app_idstringrequiredUUID of the app
Query parameters
pageintegerPage number for pagination. If not provided, all organisations are returned.
per_pageintegerNumber of items per page. Max 20. If not provided, all organisations are returned.
searchstringSearch query for organisation name and number
Responses
200
OK
companiesOrganisationWithUserRelationResponse[]Show propertiesHide properties
Array of
OrganisationWithUserRelationResponseapp_idstringattributesAttributeResponse[] | nullShow propertiesHide properties
Array of
AttributeResponsedescriptionstringidstringkeystringnamestringtemplate_keystringtranslationsAttributeTranslationsResponseShow propertiesHide properties
descriptionobjectnameobjectvaluesobjectbilling_addressCompanyAddressResponse[] | nullShow propertiesHide properties
Array of
CompanyAddressResponsecitystringco_addressstringcompany_idstringcompany_namestringcountrystringcreated_atstringhouse_numberstringidstringis_defaultbooleannamestringphonestringpostal_codestringshipping_typestringstate_provincestringstreet_addressstringupdated_atstringcommentstringcontact_namestringcreated_atstringcredit_checkbooleancustom_fieldsobjectcustom_role_idstring | nullcustomer_groupsCustomerGroupRefResponse[] | nullShow propertiesHide properties
Array of
CustomerGroupRefResponseidstringnamestringslugstringemailstringexternal_refstringfilesFileResponse[] | nullShow propertiesHide properties
Array of
FileResponseapp_idstringcontent_typestringcreated_atstringcustom_fieldsobjectfilenamestringidstringupdated_atstringurlstringidstringinvoice_emailstringlevelstring | nullnamestringorganisation_numberstring | nullparent_idstring | nullphonestringrolestring | nullrole_namestring | nullshipping_addressCompanyAddressResponse[] | nullShow propertiesHide properties
Array of
CompanyAddressResponsecitystringco_addressstringcompany_idstringcompany_namestringcountrystringcreated_atstringhouse_numberstringidstringis_defaultbooleannamestringphonestringpostal_codestringshipping_typestringstate_provincestringstreet_addressstringupdated_atstringstatusstringstore_groupsStoreGroupResponse[] | nullShow propertiesHide properties
Array of
StoreGroupResponsecountry_of_salestring | nullcreated_atstringdescriptionstring | nullidstringnamestringslugstringstore_typestringupdated_atstring | nulltagsTagResponse[] | nullShow propertiesHide properties
Array of
TagResponseapp_idstringidstringkeystringnamestringtax_id_vat_numberstringupdated_atstringpageintegertotalintegertotal_pagesinteger400
Invalid request
detailsstring[] | nullmessagestringsuccessboolean500
Internal server error
detailsstring[] | nullmessagestringsuccessboolean