List legal entities

Operation ID: entities

Group: Base › Entities

Open in the interactive reference

GET /base/entities

Read-only: Reads and returns; changes nothing.

Lists legal entities. Their id values are the entityId that most other resources reference.

Parameters

Name In Type Required Description
Api-Version header string · v1 yes The API version this request targets, named by its public identifier. Required on every request; omitting it, or naming a version this company does not have, is answered with 400. This document describes version v1.

Query surface

Response

200 Success

Under data, an array of entitiesRow:

Field Type Required Filter Sort Description
id string no Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn), Pattern (like) yes The unique identifier for the legal entity. Other resources reference it as entityId.
entityName string no no no The name of the legal entity, for example 'Acme Inc.'. Unique within the tenant.
entityNumber string | null no no no The entity's business number, separate from its name. Absent until one is assigned.
currency string | null no Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn), Pattern (like) yes The entity's functional currency, its default for reporting and posting. Format ISO 4217, for example 'USD'. Absent when none has been set.
timeZone string | null no Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn), Pattern (like) yes The time zone the entity operates in. Format IANA time-zone name, for example 'Europe/Berlin'. New entities default to 'Etc/UTC'. Absent when none has been set.
status string | null no Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn), Pattern (like) yes The lifecycle status of the entity. Possible values: 'active', 'inactive', 'created'. 'created' is the default for a new entity.
entityType string | null no Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn), Pattern (like) yes Whether the entity is a legal entity or a non-legal reporting entity. Possible values: 'LegalEntity', 'NonLegalReportingEntity'. Defaults to 'LegalEntity'.
country string | null no Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn), Pattern (like) yes The country the entity is registered in. Format ISO 3166-1 alpha-2, for example 'US'. Absent when none has been set.
entityCode string | null no Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn), Pattern (like) yes A short code for the entity, separate from its entityNumber. Absent until one is assigned.
parentId string | null no no no The parent entity in the entity hierarchy, which is what a consolidation rolls this entity up to. Absent on a top-level entity.
localeCode string | null no Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn), Pattern (like) yes The locale for documents sent from this entity, setting the language and regional format. Format BCP 47, for example 'en-US'. Absent when none has been set.
startDate date | null no Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn) yes The date the entity became effective. Format YYYY-MM-DD. Absent when none has been set.
endDate date | null no Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn) yes The date the entity stops being effective. Format YYYY-MM-DD. Absent when the entity has no scheduled end.
lastModifiedDate date-time | null no Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn) yes The date and time the entity last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ. 
{
  "data": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "entityName": "<entityName>",
      "entityNumber": "<entityNumber>",
      "currency": "<currency>",
      "timeZone": "<timeZone>",
      "status": "<status>",
      "entityType": "<entityType>",
      "country": "<country>",
      "entityCode": "<entityCode>",
      "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "localeCode": "<localeCode>",
      "startDate": "2026-01-15",
      "endDate": "2026-01-15",
      "lastModifiedDate": "2026-01-15T09:30:00.000Z"
    }
  ],
  "pagination": {
    "hasMore": true,
    "nextCursor": "<nextCursor>"
  }
}

Statuses