Skip to main content
GET
Get company

Authorizations

x-dolfin-api-key
string
header
required

An API key issued to your client. It carries the client's scope; org-scoped calls also require the x-dolfin-organisation-id header. Keys are created and revoked by a client administrator.

Headers

x-dolfin-client-id
string<uuid>

Target client. Required when your credential grants access to more than one client; omit when it resolves a single client.

Path Parameters

companyId
string<uuid>
required

Response

OK

name
string
required

Display name of the parent group, e.g. "Ozone Coffee".

id
string<uuid>
addressLine1
null | string

Head office address. Used to recognise group-level bills, which are never routed automatically to an individual site.

addressLine2
null | string
city
null | string
postalCode
null | string
country
null | string

ISO 3166-1 alpha-2 country code (e.g. GB, US, DE)

contactEmail
null | string

Contact address for notifications about bills awaiting routing.

autoAssignThreshold

Overrides the client-wide automatic-routing score for this company only. Null means the client setting applies. Useful when one group's bills carry messier addresses than the rest.

autoAssignMargin

Overrides the client-wide automatic-routing margin for this company only. Null means the client setting applies.

createdAt
string<date-time>
createdBy
null | string<uuid>
updatedAt
string<date-time>
updatedBy
null | string<uuid>