Skip to content

Rippling: GET Current Company — company Api get Companies

Rippling companyApi.getCompanies: arguments, response, policy and SDK examples.

← Company API operations · Get started

Operation rippling.company_api.get_companies

Provider route: GET /platform/api/companies/current. 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["companyApi"]["getCompanies"]>[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.companyApi.getCompanies(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.company_api.get_companies(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed

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

FieldTypePresenceDescription and constraints
$ModelRootExpand GET Current Company — company Api get Companies — response body

Referenced models: GET Current Company — company Api get Companies — response body

GET Current Company — company Api get Companies — response body
FieldTypePresenceDescription and constraints
$objectRootA company object as represented within Rippling.
addressJSONOptional
address (anyOf 1)objectAlternativeAn address object as stored within Rippling.
address (anyOf 1).citystringOptional
address (anyOf 1).countrystringOptional
address (anyOf 1).statestringOptional
address (anyOf 1).streetLine1stringOptional
address (anyOf 1).streetLine2stringOptional
address (anyOf 1).zipstringOptional
address (anyOf 2)nullAlternative
einsarrayOptional
eins[]stringEach item
entitiesModelOptionalExpand GET Current Company — base Api get Companies — response body — entities
idstringOptional
namestringOptional
phonestringOptional
primaryEmailstringOptional
subscriptionstringOptional
tax_infosarrayOptional
tax_infos[]ModelEach itemExpand GET Current Company — company Api get Companies — response body — tax infos item
workLocationsarrayOptional
workLocations[]ModelEach itemExpand GET Current Company — company Api get Companies — response body — work Locations item

Referenced models: GET Current Company — base Api get Companies — response body — entities, GET Current Company — company Api get Companies — response body — tax infos item, GET Current Company — company Api get Companies — response body — work Locations item

GET Current Company — base Api get Companies — response body — entities
FieldTypePresenceDescription and constraints
$objectRootThis model represents the legal entities inside of a given company. Legal entities based in Canada (CA) are currently supported at this time.
CAarrayOptionalCA represents Canada.
CA[]objectEach item
CA[].entityInfoobjectOptional
CA[].entityInfo.businessNumberstringOptionalThe Canada Business Number
CA[].entityInfo.legalNamestringOptionalThe legal name of the entity
CA[].idstringOptionalThe unique Rippling ID of the legal entity
CA[].isEorbooleanOptionalIf set to true, the legal entity is Rippling's EOR. If set to false, the legal entity is not on Rippling's EOR.
GET Current Company — company Api get Companies — response body — tax infos item
FieldTypePresenceDescription and constraints
$objectRootTax information object.
DbastringOptional
einstringOptional
entityTypestringOptional
futaExemptstringOptional
incorporationDatestringOptional
incorporationStatestringOptional
nameWithIrsstringOptional
postalAddressJSONOptional
postalAddress (anyOf 1)objectAlternativeAn address object as stored within Rippling.
postalAddress (anyOf 1).citystringOptional
postalAddress (anyOf 1).countrystringOptional
postalAddress (anyOf 1).statestringOptional
postalAddress (anyOf 1).streetLine1stringOptional
postalAddress (anyOf 1).streetLine2stringOptional
postalAddress (anyOf 1).zipstringOptional
postalAddress (anyOf 2)nullAlternative
signatorystringOptional
soleProprieterSSNstringOptional
GET Current Company — company Api get Companies — response body — work Locations item
FieldTypePresenceDescription and constraints
$objectRootA work location object.
addressJSONOptional
address (anyOf 1)objectAlternativeAn address object as stored within Rippling.
address (anyOf 1).citystringOptional
address (anyOf 1).countrystringOptional
address (anyOf 1).statestringOptional
address (anyOf 1).streetLine1stringOptional
address (anyOf 1).streetLine2stringOptional
address (anyOf 1).zipstringOptional
address (anyOf 2)nullAlternative
idstringOptional
nicknamestringOptional

SDK function policy ID: rippling.company_api.get_companies. Catalog operation: v1.get-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.

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.