GET
/
hris
/
groups
Get groups
curl --request GET \
  --url https://api.kombo.dev/v1/hris/groups \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Integration-Id: <x-integration-id>'
{
  "status": "success",
  "data": {
    "next": "eyJwYWdlIjoxMiwibm90ZSI6InRoaXMgaXMganVzdCBhbiBleGFtcGxlIGFuZCBub3QgcmVwcmVzZW50YXRpdmUgZm9yIGEgcmVhbCBjdXJzb3IhIn0=",
    "results": [
      {
        "id": "4B9bKBpX5tnwjiG93TAqF7ci",
        "remote_id": "49",
        "name": "Customer Success",
        "changed_at": "2022-08-07T14:01:29.196Z",
        "remote_deleted_at": null,
        "type": "TEAM",
        "parent_id": "KGaJ5XaVPob8mYVfD49W4DGB",
        "remote_data": null
      }
    ]
  }
}
Top level filters use AND, while individual filters use OR if they accept multiple arguments. That means filters will be resolved like this: (id IN ids) AND (remote_id IN remote_ids)

Authorizations

​
Authorization
string
header
required

Create an API key on the Secrets page in the Kombo dashboard.

Headers

​
X-Integration-Id
string
required

ID of the integration you want to interact with.

Query Parameters

​
cursor
string

An optional cursor string used for pagination. This can be retrieved from the next property of the previous page response.

​
page_size
integer
default:100

The number of results to return per page. Maximum is 250.

Required range: 1 <= x <= 250
​
updated_after
string<date-time>

Filter the entries based on the modification date in format YYYY-MM-DDTHH:mm:ss.sssZ. If you want to track entry deletion, also set the include_deleted=true query parameter, because otherwise, deleted entries will be hidden.

​
include_deleted
enum<string>
default:false

By default, deleted entries are not returned. Use the include_deleted query param to include deleted entries too.

Available options:
true,
false
​
ids
string

Filter by a comma-separated list of IDs such as 222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3.

​
remote_ids
string

Filter by a comma-separated list of remote IDs.

​
types
string

Filter by a comma-separated list of group types: DEPARTMENT, TEAM, COST_CENTER, or null to filter groups without a type.

Leave this blank to get results matching all values.

​
name_contains
string

Filter by the name field. Can be used to find a group by keywords present in the group name.

Response

GET /hris/groups Positive response

​
status
string
required
Allowed value: "success"
​
data
object
required
Examples:
{
  "next": "eyJwYWdlIjoxMiwibm90ZSI6InRoaXMgaXMganVzdCBhbiBleGFtcGxlIGFuZCBub3QgcmVwcmVzZW50YXRpdmUgZm9yIGEgcmVhbCBjdXJzb3IhIn0=",
  "results": [
    {
      "id": "4B9bKBpX5tnwjiG93TAqF7ci",
      "remote_id": "49",
      "name": "Customer Success",
      "changed_at": "2022-08-07T14:01:29.196Z",
      "remote_deleted_at": null,
      "type": "TEAM",
      "parent_id": "KGaJ5XaVPob8mYVfD49W4DGB",
      "remote_data": null
    }
  ]
}