Rippling: GET Group
Rippling baseApi.getGroupsGroupId: arguments, response, policy and SDK examples.
← Base API operations · Get started
Operation rippling.base_api.get_groups_groupid
Provider route: GET /platform/api/groups/{groupId}. 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"]["getGroupsGroupId"]>[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.getGroupsGroupId(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_groups_group_id(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.groupId | integer | Required within parent | |
body | Model | Optional | Expand GET Group — request body — body |
Referenced models: GET Group — request body — body
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 Group — response body |
Referenced models: GET Group — response body
Schemas
Section titled “Schemas”GET Group — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Optional | |
name | string | Optional | User-readable name of a Rippling group. |
spokeId | JSON | Optional | |
spokeId (anyOf 1) | string | Alternative | Your id for the group; this should a unique string identifier. |
spokeId (anyOf 2) | null | Alternative | |
users | array | Optional | An array of employee Rippling ids. |
users[] | string | Each item | |
version | string | Optional | The version unique identifier of the group. |
GET Group — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This payload should be used when updating existing groups. |
name | string | Optional | The name of the Group. |
spokeId | string | Optional | The external identifier of the Group. |
users | array | Optional | The array of users within the Group. |
users[] | JSON | Each item | |
version | string | Optional | The version identifier of the Group. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: rippling.base_api.get_groups_groupid. Catalog operation: v1.get-groups-groupId. 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.