Skip to content

Get an org legal entity

Settings module

GET/org-legal-entities/{id}orgLegalEntities.get

A legal entity of the organization with its fiscal settings. Returns one org legal entity with its `ETag`. A org legal entity the caller may not see returns 404.

  • Requires the capability org.settings.read.
  • OAuth scopes: org.
  • Error statuses: 400, 401, 404, 429. Errors are RFC 9457 problem details.

Path and query parameters

orgLegalEntities.get: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the org legal entity.
fieldsFieldsNoSparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Constraints: pattern ^[a-z_][a-z0-9_]*(,[a-z_][a-z0-9_]*)*$

Response 200: OrgLegalEntity

orgLegalEntities.get: OrgLegalEntity
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the org legal entity.
org_idstring (uuid)YesIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)YesWhen the row was created.
created_bystring (uuid) | nullYesIdentifier of the person who created the row; null when a seed, platform or system process created it.
updated_atstring (date-time)YesWhen the row was last updated.
updated_bystring (uuid) | nullYesIdentifier of the person who last updated the row; null when a seed, platform or system process updated it.
legal_namestringYesLegal name.Constraints: length 1 to 300
country_codestringYesISO 3166-1 alpha-2 country code.Constraints: pattern ^[A-Z]{2}$
tax_identifierstring | Masked | nullYes
fiscal_year_start_monthintegerYesFiscal year start month.Constraints: range 1 to any
base_currencystringYesBase currency.Constraints: pattern ^[A-Z]{3}$
is_primarybooleanYesTrue for the org's primary entity, printed on generated documents. The first entity is primary; marking another moves the mark.
tax_identifier_last4string | nullYesLast four characters of the tax identifier.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "updated_at": "2026-10-08T14:30:00Z",
  "updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "legal_name": "Northwind Live LLC",
  "country_code": "US",
  "tax_identifier": "123456789",
  "fiscal_year_start_month": 1,
  "base_currency": "USD",
  "is_primary": true,
  "tax_identifier_last4": "6789"
}

Code samples

curl -X GET "$XOS_BASE_URL/org-legal-entities/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY"
const { data, etag } = await xos.orgLegalEntities.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");
response = xos.org_legal_entities.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")
xos org-legal-entities get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f