Skip to main content
GET
Get business

Authorizations

Authorization
string
header
required

Partner-level JWT token (unscoped). Token payload includes partner_id. Business access is validated via partner ownership. Format: Bearer <your-jwt-token>

Use this for: Multi-business operations where the business_id is specified in the URL and partner has access to multiple businesses.

Path Parameters

business_id
string<uuid>
required

A UUID string identifying this business.

Response

200 - application/json

Full business serializer for list and detail views

id
string<uuid>
required
read-only

Unique identifier for the business

Legal registered name of the business

Maximum string length: 255
country
string
required

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

Maximum string length: 2
email
string<email>
required

Primary email address for the business

base_currency
string
required

Base currency for accounting (ISO 4217 code)

Maximum string length: 3
accounting_method
string
required

Accounting method: 'cash' or 'accrual'

Maximum string length: 20
fiscal_year_end
string<date>
required

Fiscal year end date

activation_at
string<date-time>
required
read-only

Date and time when the business was activated

is_active
boolean
required
read-only

Whether the business is active (false if archived)

created_at
string<date-time>
required
read-only

Date and time when the business was created

updated_at
string<date-time>
required
read-only

Date and time when the business was last updated

external_id
string

Your unique identifier for this business

name
string

Display name for the business (defaults to legal_name)

Maximum string length: 255
entity_type
string

Business entity type (e.g., 'limited', 'gmbh', 'bv')

phone_number
string

Business phone number

tin
string

Tax identification number (other than VAT)

vat_number
string

EU VAT registration number

company_number
string

Company registration number (e.g., Companies House number for UK)

province
string

Province or state within the country

Maximum string length: 100
eu_nace_industry_code
string

European NACE industry classification code

Maximum string length: 10
metadata
any

Custom JSON metadata for partner-specific data