GET Group

Please note, the Groups endpoint requires an OAuth application (i.e. approved 3rd party partners), as the end point is intended for mapping third-party application “Groups” within Rippling organizations.

GET /platform/api/groups/{groupId}

GET Group

cURL

curl --request GET \
  --url https://api.rippling.com/platform/api/groups/{groupId} \
  --header 'Authorization: Bearer <token>'

200

{
  "id": "5f397f3b3ca04e478d4575ad",
  "spokeId": "lkjwbfskjsdbllskdb",
  "name": "GroupTest",
  "users": [],
  "version": "yvmzhfw50hn39aas"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

groupId · integer · required

Unique identifier for the group within Rippling.

Response

200 - application/json

OK

name · string

User-readable name of a Rippling group.

id · string

spokeId · string | null

Your id for the group; this should a unique string identifier.

version · string

The version unique identifier of the group.

users · string[]

An array of employee Rippling ids.