Skip to main content
GET
Get active client settings

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.

Response

OK

name
string
required
id
string<uuid>
type
enum<string>
Available options:
Live,
Sandbox
paymentRevenueSharePercent
dolfinRevenueSharePercent
logoUrl
null | string
primaryColour
null | string
modules
string[]

The modules this client is entitled to, such as "ar", "ap" or "ap.payments". Use it to hide features the client has not purchased instead of calling and handling a 403. Re-fetch after a 403 that names a module — entitlements are resolved per request, so this list always matches what the API will actually allow.

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