Companies

Scope: company.profile:read. Bank fields additionally require company.bank_details:read.

List companies

GET /user-companies

With a Bearer key this returns a one-element list containing the full record of the company the key is bound to. With legacy credentials it returns short {company_id, name} entries for every company the user can reach.

Get a company

GET /user-companies/{company_id}

Returns the full company record. This is the endpoint to use when you want a predictable response regardless of how you authenticated.

Note

Bank fields (bankgiro, plusgiro, IBAN, BIC) are only included if the key also holds company.bank_details:read. Without that scope the request still succeeds — the fields are simply absent. Do not treat a missing bank field as “the company has none”.

Company versions

GET /user-companies/{company_id}/versions

Returns version information for the company.

Unauthenticated

GET /myip

Returns the calling client’s IP address. No authentication required. Useful for confirming connectivity and for finding the source address to allowlist on your side.