Skip to content

Deel: List of legal entities

Deel legalEntities.getLegalEntities: arguments, response, policy and SDK examples.

← Legal entities operations · Get started

Operation deel.legalentities_getlegalentities

Provider route: GET /legal-entities. Alter supplies the connection’s credentials and routing.

Install @alter-ai/sdk @alter-ai/deel with npm, or alter-sdk-deel with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { DeelIntegration } from "@alter-ai/deel";
async function execute(input: Parameters<DeelIntegration["legalEntities"]["getLegalEntities"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new DeelIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.legalEntities.getLegalEntities(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_deel import DeelIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = DeelIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.legal_entities.get_legal_entities(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
queryobjectOptionalAdditional keys: not allowed
query.limitintegerOptionalDefault: 100
Maximum: 100
Minimum: 1
query.sort_orderstringOptionalDefault: ASC
One of: ASC, DESC
query.cursorstringOptional
query.include_archivedbooleanOptionalDefault: true
query.legal_entity_idstringOptional
query.global_payrollbooleanOptional
query.typestringOptional
query.countrystringOptional
query.include_payroll_settingsbooleanOptional

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand List of legal entities — 200 response body

Referenced models: List of legal entities — 200 response body

List of legal entities — 200 response body
FieldTypePresenceDescription and constraints
$objectRoot
dataarrayOptional
data[]ModelEach itemExpand List of legal entities — 200 response body — data item
pageModelOptionalExpand List of legal entities — 200 response body — page

Referenced models: List of legal entities — 200 response body — data item, List of legal entities — 200 response body — page

List of legal entities — 200 response body — data item
FieldTypePresenceDescription and constraints
$objectRoot
addressJSONOptional
address (anyOf 1)ModelAlternativeExpand List of legal entities — 200 response body — data item address city, country, state, street, zip
address (anyOf 2)nullAlternative
archived_atJSONOptional
archived_at (anyOf 1)stringAlternativeArchived date
Format: date-time
archived_at (anyOf 2)nullAlternativeArchived date
Format: date-time
countryJSONOptional
country (anyOf 1)stringAlternativeCountry of the legal entity
country (anyOf 2)nullAlternativeCountry of the legal entity
created_atstringOptionalCreated date
Format: date-time
entity_subtypestringOptionalEntity sub type
entity_typeJSONOptionalEntity type
entity_type (anyOf 1)stringAlternativeEntity type
Known values: individual, company, light
entity_type (anyOf 2)nullAlternative
idstringOptionalId of the legal entity
industry_nameJSONOptional
industry_name (anyOf 1)stringAlternativeIndustry name
industry_name (anyOf 2)nullAlternativeIndustry name
namestringOptionalName of the legal entity
phoneJSONOptional
phone (anyOf 1)stringAlternativePhone number
phone (anyOf 2)nullAlternativePhone number
registrationNumberJSONOptional
registrationNumber (anyOf 1)stringAlternativeRegistration number
registrationNumber (anyOf 2)nullAlternativeRegistration number
sic_numberJSONOptional
sic_number (anyOf 1)stringAlternativeSIC Company Identifier
sic_number (anyOf 2)nullAlternativeSIC Company Identifier
statusstringOptionalThe mapped legal entity lifecycle status, the same value as on the single legal entity endpoint. Returned only when the feature is enabled for the organization.
Known values: archived, active, draft, processing, processing_draft, pending_verification, awaiting_review, unknown
updated_atstringOptionalUpdated date
Format: date-time
vat_idJSONOptional
vat_id (anyOf 1)stringAlternativeVAT ID
vat_id (anyOf 2)nullAlternativeVAT ID

Referenced models: List of legal entities — 200 response body — data item address city, country, state, street, zip

List of legal entities — 200 response body — page
FieldTypePresenceDescription and constraints
$objectRoot
cursorJSONOptional
cursor (anyOf 1)stringAlternativeCursor link
cursor (anyOf 2)nullAlternativeCursor link
List of legal entities — 200 response body — data item address city, country, state, street, zip
FieldTypePresenceDescription and constraints
$objectRoot
cityJSONOptional
city (anyOf 1)stringAlternativeCity
city (anyOf 2)nullAlternativeCity
countryJSONOptional
country (anyOf 1)stringAlternativeCountry
country (anyOf 2)nullAlternativeCountry
stateJSONOptional
state (anyOf 1)stringAlternativeState
state (anyOf 2)nullAlternativeState
streetJSONOptional
street (anyOf 1)stringAlternativeStreet
street (anyOf 2)nullAlternativeStreet
zipJSONOptional
zip (anyOf 1)stringAlternativeZip code
zip (anyOf 2)nullAlternativeZip code

SDK function policy ID: deel.legalentities_getlegalentities. Catalog operation: legalentities_getlegalentities. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["organizations:read", "accounting:read"]

Pinned headers: {"X-Version": "2026-01-01"}

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.