Get organisation details and settings

GET https://app.speybooks.com/api/v1/organisation/

Returns the full organisation record including profile fields, operational settings, and invoice/quote numbering configuration. The settings object merges data from the organisations.settings JSONB column and the settings key-value table.

The address is returned as a nested object for display convenience.

Response

200 Returns full organisation profile, address, VAT settings, invoice settings, and quote settings.
Show response fields
address object
Show child attributes
city string
country string
line1 string
line2 string nullable
postalCode string
region string
businessType string
companyNumber string nullable
createdAt string date-time
email string
id string
invoiceSettings object
Show child attributes
defaultNotes string
defaultTerms string
nextNumber integer
prefix string
name string
phone string nullable
quoteSettings object
Show child attributes
defaultNotes string
defaultTerms string
nextNumber integer
prefix string
validityDays integer
settings object
Show child attributes
currency string
fiscalYearStart string
vatFlatRatePercent string nullable
vatRegistered boolean
vatScheme string
slug string
updatedAt string date-time
vatNumber string nullable
website string nullable

Error codes

404 Organisation not found.