Skip to content

Rippling: List companies

Rippling restApi.listCompanies: arguments, response, policy and SDK examples.

← Rest API operations · Get started

Operation rippling.rest_api.list_companies

Provider route: GET /companies/. Alter supplies the connection’s credentials and routing.

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"]["listCompanies"]>[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.listCompanies(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.list_companies(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
queryobjectOptionalAdditional keys: not allowed
query.expandstringOptional
query.order_bystringOptional
query.limitintegerOptionalDefault: 50
Maximum: 100
Minimum: 1
query.cursorstringOptional

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

FieldTypePresenceDescription and constraints
$objectRoot
__metaModelOptionalExpand List Sites — response body — meta
next_linkstringOptionalA link to the next page of responses.
Format: uri
resultsarrayOptional
results[]ModelEach itemExpand List companies — response body — results item

Referenced models: List companies — response body — results item, List Sites — response body — meta

5 more schemas are linked from the tables above, on the schema pages.

List companies — response body — results item
FieldTypePresenceDescription and constraints
$objectRoot
created_atstringRequired within parentRecord creation date
doing_business_as_namestringOptionalThe doing business as name for the company.
idstringRequired within parentIdentifier field
legal_entitiesarrayRequired within parentA list of the company's entities.

Expandable field
legal_entities[]ModelEach itemExpand Retrieve my SSO information — response body — company legal entities item
legal_entities_idarrayRequired within parentA list of the company's entities.
legal_entities_id[]stringEach item
legal_namestringOptionalThe legal name of the company.
namestringRequired within parentThe name of the company.
parent_legal_entityModelOptionalExpand Retrieve my SSO information — response body — company parent legal entity
parent_legal_entity_idstringOptionalThe company's ultimate holding entity.
phonestringOptionalThe phone number for the company.
physical_addressModelOptionalExpand Retrieve my SSO information — response body — company physical address
primary_emailstringOptionalThe email address used when registering this company.
updated_atstringRequired within parentRecord update date

Referenced models: Retrieve my SSO information — response body — company legal entities item, Retrieve my SSO information — response body — company parent legal entity, Retrieve my SSO information — response body — company physical address

List Sites — response body — meta
FieldTypePresenceDescription and constraints
$objectRootA list of redacted fields.
redacted_fieldsarrayOptional
redacted_fields[]objectEach item
redacted_fields[].namestringOptionalThe name for the redacted field
redacted_fields[].reasonstringOptionalThe reason for the redaction
Retrieve my SSO information — response body — company legal entities item
FieldTypePresenceDescription and constraints
$objectRoot
companyModelOptionalExpand List companies — response body — results item
The company or organization associated with the legal entity

Expandable field
company_idstringOptionalThe company or organization associated with the legal entity
countryModelOptionalExpand Retrieve a specific legal entity — response body — country
created_atstringRequired within parentRecord creation date
entity_levelstringOptionalThe legal 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
idstringRequired within parentIdentifier field
legal_namestringOptionalThe legal name of the legal entity.
mailing_addressModelOptionalExpand Retrieve a specific legal entity — response body — mailing address
management_typestringOptionalThe legal entity management type in the case of an employer of record (EOR) or professional employment organization (PEO). * `PEO`: The legal entity is considered a Professional Employment Organization (PEO). * `EOR`: The legal entity is considered an Employer of Record (EOR).
Known values: PEO, EOR, COR
parentModelOptionalExpand Retrieve a specific legal entity — response body — parent
The parent legal entity.

Expandable field
parent_idstringOptionalThe parent legal entity.
physical_addressModelOptionalExpand Retrieve a specific legal entity — response body — physical address
registration_datestringOptionalThe registration date of the entity.
tax_identifierstringOptionalThe tax identifier for the legal entity.
updated_atstringRequired within parentRecord update date

Referenced models: List companies — response body — results item, Retrieve a specific legal entity — response body — parent, Retrieve a specific legal entity — response body — country, Retrieve a specific legal entity — response body — mailing address, Retrieve a specific legal entity — response body — physical address

Retrieve my SSO information — response body — company parent legal entity
FieldTypePresenceDescription and constraints
$objectRootThe company's ultimate holding entity.

Expandable field
companyModelOptionalExpand List companies — response body — results item
The company or organization associated with the legal entity

Expandable field
company_idstringOptionalThe company or organization associated with the legal entity
countryModelOptionalExpand Retrieve a specific legal entity — response body — country
created_atstringRequired within parentRecord creation date
entity_levelstringOptionalThe legal 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
idstringRequired within parentIdentifier field
legal_namestringOptionalThe legal name of the legal entity.
mailing_addressModelOptionalExpand Retrieve a specific legal entity — response body — mailing address
management_typestringOptionalThe legal entity management type in the case of an employer of record (EOR) or professional employment organization (PEO). * `PEO`: The legal entity is considered a Professional Employment Organization (PEO). * `EOR`: The legal entity is considered an Employer of Record (EOR).
Known values: PEO, EOR, COR
parentModelOptionalExpand Retrieve a specific legal entity — response body — parent
The parent legal entity.

Expandable field
parent_idstringOptionalThe parent legal entity.
physical_addressModelOptionalExpand Retrieve a specific legal entity — response body — physical address
registration_datestringOptionalThe registration date of the entity.
tax_identifierstringOptionalThe tax identifier for the legal entity.
updated_atstringRequired within parentRecord update date

Referenced models: List companies — response body — results item, Retrieve a specific legal entity — response body — parent, Retrieve a specific legal entity — response body — country, Retrieve a specific legal entity — response body — mailing address, Retrieve a specific legal entity — response body — physical address

Retrieve my SSO information — response body — company physical address
FieldTypePresenceDescription and constraints
$objectRootThe physical address of the holding entity.
countrystringOptionalThe country component, pursuant to SCIM RFC 7643 4.1.2.
Known values: AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, BN, BG, BF, BI, CV, KH, CM, CA, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CD, CK, CR, CI, HR, CW, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, SZ, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IQ, IR, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KR, XK, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, AN, NC, NZ, NI, NE, NG, NU, NF, MK, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RO, RU, RW, RE, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SY, SK, SI, SB, SO, ZA, GS, SS, ES, LK, SD, SR, SJ, SE, CH, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, US, UM, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW
formattedstringOptionalThe formatted mailing address.
localitystringOptionalThe city or locality component.
postal_codestringOptionalThe zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.
regionstringOptionalThe state or region component, pursuant to SCIM RFC 7643 4.1.2.
street_addressstringOptionalThe full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..
typestringOptionalThe classification of the address.
Known values: HOME, WORK, OTHER

SDK function policy ID: rippling.rest_api.list_companies. Catalog operation: list-companies. 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: ["companies.read"]

Provider entitlements: ["API_Tier_1"]

Pinned headers: {"Rippling-Api-Version": "2024-08-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.