Skip to main content
GET
/
platform
/
api
/
groups
GET Groups
curl --request GET \
  --url https://api.rippling.com/platform/api/groups \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "5f397ed33ca04e4ab23246c2",
    "spokeId": "123456xvbnm12345678912354939",
    "name": "GroupTest3",
    "users": [
      "invalid_user_id"
    ],
    "version": "t4lz8cjhc54ludro"
  },
  {
    "id": "5f397f3b3ca04e478d4575ad",
    "spokeId": "lkjwbfskjsdbllskdb",
    "name": "GroupTest4",
    "users": [
      "5c8f7f06c592917aeee1ea9f"
    ],
    "version": "uu8ccavwbsb8stfn"
  }
]

Authorizations

​
Authorization
string
header
required

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

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.