Rippling: Retrieve a specific company legal entity

← rest_api operations · Get started · OpenAPI downloads

Contract 2026-10-28 · Operation rippling.rest_api.get_company_legal_entities

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

Call through Alter

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

import { App } from "@alter-ai/sdk";
import { RipplingIntegration } from "@alter-ai/rippling";

async function execute(input: Parameters<RipplingIntegration["restApi"]["getCompanyLegalEntities"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new RipplingIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.restApi.getCompanyLegalEntities(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_rippling import RipplingIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = RipplingIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.rest_api.get_company_legal_entities(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.id	string	Required within parent	Format: id

Response

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

Field	Type	Presence	Description and constraints
$	object	Root
__meta	object	Optional
__meta.redacted_fields	array	Optional
__meta.redacted_fields[]	Model	Each item	Expand Retrieve a report run — response body — meta redacted fields item
company_id	string	Optional	The company associated with this entity relationship.
country_code	string	Optional	The ISO country code for the entity.
created_at	string	Required within parent	Record creation date
entity_level	string	Optional	The entity’s level in a hierarchy. * `PARENT`: The legal entity is considered the ultimate holding entity. * `SUBSIDIARY`: The legal entity is considered a subsidiary, fully or partially held by another. * `BRANCH`: The legal entity is considered a branch, associated with a parent legal entity. Known values: PARENT, SUBSIDIARY, BRANCH
id	string	Required within parent	Identifier field
is_archived	boolean	Optional	True if this entity relationship has been archived.
is_cor	boolean	Optional	True if this entity is managed as a Contractor of Record.
is_eor	boolean	Optional	True if this entity is managed as an Employer of Record.
is_peo	boolean	Optional	True if this entity is managed as a Professional Employment Organization.
legal_name	string	Optional	The legal name of the entity.
mailing_address	Model	Optional	Expand Retrieve a specific company legal entity — response body — mailing address
management_type	string	Optional	The entity management type. * `EOR`: The entity is managed as an Employer of Record. * `COR`: The entity is managed as a Contractor of Record. * `PEO`: The entity is managed as a Professional Employment Organization. * `null`: The entity is a direct hire with no managed employment type. Known values: PEO, EOR, COR
physical_address	Model	Optional	Expand Retrieve a specific company legal entity — response body — physical address
registration_date	string	Optional	The registration date of the entity.
tax_identifier	string	Optional	The tax identifier for this entity.
updated_at	string	Required within parent	Record update date

Referenced models: Retrieve a report run — response body — meta redacted fields item, Retrieve a specific company legal entity — response body — mailing address, Retrieve a specific company legal entity — response body — physical address

Policy, approvals and errors

SDK function policy ID: rippling.rest_api.get_company_legal_entities. Catalog operation: get-company-legal-entities. 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: ["company-legal-entities.read"]

Provider entitlements: ["API_Tier_1"]

Pinned headers: {"Rippling-Api-Version": "2024-08-01"}

Official provider source