GET/v1/organisation

Get the organisation profile and settings

Scope templates.read

Returns

12 fields of the 200 answer

idstringrequired

namestringrequired

slugstringrequired

localeenumrequired

nlen

statusenumrequired

ACTIVESUSPENDEDPENDING_DELETION

billingModeenumrequired

PREPAIDTRIALINVOICE

settingsobjectrequired

5 fields

retentionDaysintegerrequired

requirePostflowApprovalbooleanrequired

requireMfabooleanrequired

postbatchApprovalThresholdintegerrequired

lowBalanceThresholdCentsinteger or nullrequired

adminobjectrequired

7 fields

priorityintegerrequired

creditLimitCentsintegerrequired

paymentTermDaysintegerrequired

trialItemsRemainingintegerrequired

trialExpiresAtdate-time or nullrequired

rateLimitsobject or nullrequired

7 fields

generalinteger

itemCreateinteger

previewinteger

uploadinteger

exportinteger

inviteinteger

publicinteger

effectiveRateLimitsobjectrequired

7 fields

generalintegerrequired

itemCreateintegerrequired

previewintegerrequired

uploadintegerrequired

exportintegerrequired

inviteintegerrequired

publicintegerrequired

createdAtdate-timerequired

billingProfileobject or nullrequired

16 fields

idstringrequired

organisationIdstringrequired

legalNamestringrequired

addressLine1stringrequired

addressLine2string or nullrequired

postalCodestringrequired

citystringrequired

countrystringrequired

invoiceEmailstringrequired

vatNumberstring or nullrequired

vatTreatmentenumrequired

NL_STANDARDEU_REVERSE_CHARGENON_EU

viesStatusenumrequired

UNCHECKEDVALIDINVALIDUNAVAILABLE

viesCheckedAtdate-time or nullrequired

viesNamestring or nullrequired

createdAtdate-timerequired

updatedAtdate-timerequired

roleenum or nullrequired

OWNERADMINEDITORAPPROVERDEVELOPERVIEWER

permissionsarray of enumrequired

organisation.manageorganisation.settingsorganisation.readmembers.managebilling.readbilling.managetemplates.readtemplates.writepostflows.readpostflows.writepostbatches.writepostbatches.approveitems.readitems.writeitems.approvesuppressions.manageapikeys.managewebhooks.manageintegrations.manageintegrations.readsupport_sessions.read

Responses

200Success

401Authentication required or API key invalid

403Permission or scope missing, organisation suspended

429Rate limited for this API key and class; wait Retry-After seconds

otherError (RFC 9457 problem details)

{ "id": "org_01J9Y2K8QF4T6W8Z0B2D4F6H8K", "name": "Welcome card", "slug": "Example", "locale": "nl", "status": "ACTIVE", "billingMode": "PREPAID", "settings": { "retentionDays": 1, "requirePostflowApproval": false, "requireMfa": false, "postbatchApprovalThreshold": 1, "lowBalanceThresholdCents": 1250 }, "admin": { "priority": 1, "creditLimitCents": 1250, "paymentTermDays": 1, "trialItemsRemaining": 1, "trialExpiresAt": "2026-10-16T09:14:02.000Z", "rateLimits": { "general": 1, "itemCreate": 1, "preview": 1, "upload": 1, "export": 1, "invite": 1, "public": 1 }, "effectiveRateLimits": { "general": 1, "itemCreate": 1, "preview": 1, "upload": 1, "export": 1, "invite": 1, "public": 1 } }, "createdAt": "2026-10-16T09:14:02.000Z", "billingProfile": { "id": "imp_01J9Y2K8QF4T6W8Z0B2D4F6H8K", "organisationId": "org_01J9Y2K8QF4T6W8Z0B2D4F6H8K", "legalName": "Example", "addressLine1": "Oudegracht 112", "addressLine2": "2nd floor", "postalCode": "3511 AX", "city": "Utrecht", "country": "NL", "invoiceEmail": "sanne@example.com", "vatNumber": "NL123456789B01", "vatTreatment": "NL_STANDARD", "viesStatus": "UNCHECKED", "viesCheckedAt": "2026-10-16T09:14:02.000Z", "viesName": "Example", "createdAt": "2026-10-16T09:14:02.000Z", "updatedAt": "2026-10-16T09:14:02.000Z" }, "role": "OWNER", "permissions": [ "organisation.manage" ] }