GET Group

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

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

GET

platform

api

groups

{groupId}

GET Group

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

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

Authorization

string

header

required

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

groupId

integer

required

Unique identifier for the group within Rippling.

200 - application/json

name

string

User-readable name of a Rippling group.

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.

⌘I