{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/GetHrisGroupsPositiveResponse",
"title": "GetHrisGroupsPositiveResponse",
"type": "object",
"properties": {
"status": {
"type": "string",
"const": "success"
},
"data": {
"type": "object",
"properties": {
"next": {
"type": [
"string",
"null"
],
"description": "Cursor string that can be passed to the `cursor` query parameter to get the next page. If this is `null`, then there are no more pages."
},
"results": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The globally unique ID of this object generated by Kombo. We recommend using this as a stable primary key for syncing."
},
"remote_id": {
"type": "string",
"description": "The raw ID of the object in the remote system. We don't recommend using this as a primary key on your side as it might sometimes be compromised of multiple identifiers if a system doesn't provide a clear primary key."
},
"name": {
"type": [
"string",
"null"
],
"description": "The name of the group."
},
"changed_at": {
"description": "The timestamp when this specific record was last modified. This field only updates when properties directly on this record change, NOT when related or nested models change. For filtering that considers nested data changes, use the `updated_after` parameter which will return records when either the record itself OR its related models have been updated.",
"type": "string",
"format": "date-time",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString"
}
},
"remote_deleted_at": {
"description": "The date and time the object was deleted in the remote system. Objects are automatically marked as deleted when Kombo can't retrieve them from the remote system anymore. Kombo will also anonymize entries 14 days after they disappear.",
"type": [
"string",
"null"
],
"format": "date-time",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString"
}
},
"type": {
"type": [
"string",
"null"
],
"enum": [
"DEPARTMENT",
"TEAM",
"COST_CENTER"
],
"description": "Type of the group."
},
"parent_id": {
"type": [
"string",
"null"
],
"description": "The Kombo ID of the group\u2019s parent group in the organizational structure. The ID can be used to retrieve the group from the `get groups` endpoint."
},
"remote_data": {
"type": [
"object",
"null"
],
"additionalProperties": true,
"description": "Includes the data fetched from the remote system.\nPlease be aware that including this in you scope config might violate other\nscopes that are set.\n\nRemote data always has the endpoint path that we got the data from as the\ntop level key. For example, it could look like: `{ \"/companies\": { ... }}`\n\nThis is not available on all plans. Reach out to Kombo if you need it."
}
},
"required": [
"id",
"remote_id",
"name",
"changed_at",
"remote_deleted_at",
"type",
"parent_id",
"remote_data"
],
"examples": [
{
"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
}
]
}
}
},
"required": [
"next",
"results"
],
"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
}
]
}
]
}
},
"required": [
"status",
"data"
]
}