Rippling: GET Current Company — base Api get Companies
Rippling baseApi.getCompanies: arguments, response, policy and SDK examples.
← Base API operations · Get started
Operation rippling.base_api.get_companies
Provider route: GET /platform/api/companies/current. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “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["baseApi"]["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.baseApi.getCompanies(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom 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.base_api.get_companies(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
Response
Section titled “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 |
|---|---|---|---|
$ | Model | Root | Expand GET Current Company — base Api get Companies — response body |
Referenced models: GET Current Company — base Api get Companies — response body
Schemas
Section titled “Schemas”GET Current Company — base Api get Companies — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A company object as represented within Rippling. |
address | JSON | Optional | |
address (anyOf 1) | Model | Alternative | Expand GET Current Company — base Api get Companies — response body — address An address object as stored within Rippling |
address (anyOf 2) | null | Alternative | |
entities | Model | Optional | Expand GET Current Company — base Api get Companies — response body — entities |
id | string | Optional | |
name | string | Optional | |
phone | string | Optional | |
primaryEmail | string | Optional | |
workLocations | array | Optional | |
workLocations[] | Model | Each item | Expand GET Work Locations — response body — item |
Referenced models: GET Current Company — base Api get Companies — response body — entities, GET Work Locations — response body — item, GET Current Company — base Api get Companies — response body — address An address object as stored within Rippling
GET Current Company — base Api get Companies — response body — entities
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This model represents the legal entities inside of a given company. Legal entities based in Canada (CA) are currently supported at this time. |
CA | array | Optional | CA represents Canada. |
CA[] | object | Each item | |
CA[].entityInfo | object | Optional | |
CA[].entityInfo.businessNumber | string | Optional | The Canada Business Number |
CA[].entityInfo.legalName | string | Optional | The legal name of the entity |
CA[].id | string | Optional | The unique Rippling ID of the legal entity |
CA[].isEor | boolean | Optional | If set to true, the legal entity is Rippling's EOR. If set to false, the legal entity is not on Rippling's EOR. |
GET Work Locations — response body — item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A work location object. |
address | JSON | Optional | |
address (anyOf 1) | Model | Alternative | Expand GET Current Company — base Api get Companies — response body — address An address object as stored within Rippling |
address (anyOf 2) | null | Alternative | |
id | string | Optional | |
nickname | string | Optional |
Referenced models: GET Current Company — base Api get Companies — response body — address An address object as stored within Rippling
GET Current Company — base Api get Companies — response body — address An address object as stored within Rippling
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | An address object as stored within Rippling. |
city | string | Optional | |
country | string | Optional | |
isRemote | boolean | Optional | |
phone | string | Optional | |
state | string | Optional | |
steLocationCode | object | Optional | |
steLocationCode.cityCode | string | Optional | |
steLocationCode.countyCode | string | Optional | |
steLocationCode.isOverridden | string | Optional | |
steLocationCode.locationCode | string | Optional | |
steLocationCode.municipalityCode | string | Optional | |
steLocationCode.psdCode | string | Optional | |
steLocationCode.schoolCode | string | Optional | |
steLocationCode.stateCode | string | Optional | |
steLocationCode.transitDistrictCode | string | Optional | |
streetLine1 | string | Optional | |
streetLine2 | string | Optional | |
zip | string | Optional |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: rippling.base_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.