GET
Get Organization

Authorizations

Authorization
string
header
required

Get token from Auth0 and paste it here

Path Parameters

organization_id
string
required

Query Parameters

valid_at
string<date> | null

Valid-time date to read, past or future. Defaults to today, or to the first upcoming edition when nothing is valid yet.

Response

Successful Response

The organization with every satellite as it reads on one date. A satellite never written, or with no slice on an explicit date, is null.

client_id
string
required
read-only
country_code
string
required
read-only
Allowed value: "GB"
created_at
string<date-time>
required
read-only
created_by
string
required
read-only

Who created the hub: the acting user (X-Acting-User, else the access credential), system for our own writes, or <authority>:<notice> for a write on an authority's behalf, e.g. hmrc:P6.

deleted_at
string<date-time> | null
required

When the hub was closed

external_ref
string | null
required
id
string
required
status
GBOrganizationStatus · object
required

The read-only status satellite. It carries no fields; it exists so that every organization read has a status object.

address
GBOrganizationAddressSatellite · object | null
bank
GBOrganizationBankSatellite · object | null
contact
GBOrganizationContactSatellite · object | null
core
GBOrganizationCoreSatellite · object | null
insurance
GBOrganizationInsuranceSatellite · object | null
tax
GBOrganizationTaxSatellite · object | null