{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/GetHrisTimesheetsPositiveResponse",
"title": "GetHrisTimesheetsPositiveResponse",
"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",
"null"
],
"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."
},
"employee_id": {
"type": "string",
"description": "The Kombo ID of the employee to which the timesheet belongs. The ID can be used to retrieve the employee from the `get employees` endpoint."
},
"started_at": {
"description": "Start time of the shift, converted into UTC time zone.",
"type": [
"string",
"null"
],
"format": "date-time",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString"
}
},
"ended_at": {
"description": "End time of the shift, converted into UTC time zone.",
"type": [
"string",
"null"
],
"format": "date-time",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString"
}
},
"timezone": {
"type": [
"string",
"null"
],
"pattern": "^[+-](?:0\\d|1[0-4]):[0-5]\\d$",
"description": "The ISO 8601 numeric UTC offset of the timesheet location in the format \u00b1HH:MM (e.g., \"+02:00\", \"-05:30\"). If null, the original offset information was not available. You can use this to display the right timezone for the timesheet in the UI."
},
"payable_hours": {
"type": [
"number",
"null"
],
"format": "double",
"minimum": -1.7976931348623157e+308,
"description": "Payable hours including grace periods - only if available in the HRIS. Won't be calculated through Kombo."
},
"unpaid_break_minutes": {
"type": [
"number",
"null"
],
"format": "double",
"minimum": -1.7976931348623157e+308,
"description": "Unpaid break in minutes - will be from the HRIS or calculated by Kombo if we have concrete unpaid break times."
},
"breaks": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {
"ended_at": {
"anyOf": [
{
"description": "YYYY-MM-DDTHH:mm:ss.sssZ",
"type": "string",
"format": "date-time",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString"
}
},
{
"type": "string",
"format": "date-time",
"pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?Z$"
}
],
"description": "End time of the break."
},
"paid": {
"type": "boolean",
"description": "Whether the break is paid or unpaid."
},
"started_at": {
"anyOf": [
{
"description": "YYYY-MM-DDTHH:mm:ss.sssZ",
"type": "string",
"format": "date-time",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString"
}
},
{
"type": "string",
"format": "date-time",
"pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?Z$"
}
],
"description": "Start time of the break."
}
},
"required": [
"ended_at",
"paid",
"started_at"
]
},
"description": "Concrete times of the breaks."
},
"approval_status": {
"type": [
"string",
"null"
],
"description": "Approval status of the shift. Can be PENDING, APPROVED, REJECTED, or null."
},
"approved_at": {
"description": "The time when the shift was approved.",
"type": [
"string",
"null"
],
"format": "date-time",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString"
}
},
"comment": {
"type": [
"string",
"null"
],
"description": "Comment on the shift."
},
"custom_fields": {
"type": [
"object",
"null"
],
"additionalProperties": true,
"description": "A key-value store of fields not covered by the schema. [Read more](/custom-fields)"
},
"integration_fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The globally unique ID of this object."
},
"key": {
"type": "string",
"description": "The key of the field in the remote system."
},
"type": {
"type": "string",
"enum": [
"DEFAULT",
"CUSTOM"
],
"description": "- `DEFAULT`: static fields in the remote system.\n- `CUSTOM`: fields that are created/editable by the user."
},
"value": {
"type": "null",
"description": "The field's value."
},
"label": {
"type": [
"string",
"null"
],
"description": "The label of the field. (not always available)"
}
},
"required": [
"id",
"key",
"type",
"label"
]
},
"description": "An array of selected passthrough integration fields. [Read more](/integration-fields)",
"examples": [
[
{
"id": "5NVFhMpB9Ah6by44tzNjZLyE",
"key": "firstName",
"type": "DEFAULT",
"value": "Frank",
"label": "First Name"
},
{
"id": "8nuajYpoRd5GnxEQaaWKUDYQ",
"key": "customTshirtSize",
"type": "CUSTOM",
"value": "XL",
"label": "T-Shirt Size"
}
]
]
},
"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"
}
},
"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",
"employee_id",
"started_at",
"ended_at",
"timezone",
"payable_hours",
"unpaid_break_minutes",
"approval_status",
"approved_at",
"comment",
"custom_fields",
"integration_fields",
"changed_at",
"remote_deleted_at",
"remote_data"
],
"examples": [
{
"id": "C1BB1C36-FE1D-4185-AAB8-0716D8FBA017",
"remote_id": "446655440000",
"employee_id": "289AD550-8659-4305-92B2-6EAA006AAB17",
"started_at": "2025-04-16T09:02:00.000Z",
"ended_at": "2025-04-16T16:59:00.000Z",
"timezone": "-04:00",
"payable_hours": 8,
"unpaid_break_minutes": 30,
"breaks": [
{
"ended_at": "2025-04-16T12:30:00.000Z",
"paid": false,
"started_at": "2025-04-16T12:00:00.000Z"
}
],
"approval_status": "APPROVED",
"approved_at": "2025-04-16T17:05:31.000Z",
"comment": "Sprint planning & code review",
"custom_fields": {},
"integration_fields": [],
"changed_at": "2022-08-07T14:01:29.196Z",
"remote_deleted_at": null,
"remote_data": {}
}
]
}
}
},
"required": [
"next",
"results"
],
"examples": [
{
"next": "eyJwYWdlIjoxMiwibm90ZSI6InRoaXMgaXMganVzdCBhbiBleGFtcGxlIGFuZCBub3QgcmVwcmVzZW50YXRpdmUgZm9yIGEgcmVhbCBjdXJzb3IhIn0=",
"results": [
{
"id": "C1BB1C36-FE1D-4185-AAB8-0716D8FBA017",
"remote_id": "446655440000",
"employee_id": "289AD550-8659-4305-92B2-6EAA006AAB17",
"started_at": "2025-04-16T09:02:00.000Z",
"ended_at": "2025-04-16T16:59:00.000Z",
"timezone": "-04:00",
"payable_hours": 8,
"unpaid_break_minutes": 30,
"breaks": [
{
"ended_at": "2025-04-16T12:30:00.000Z",
"paid": false,
"started_at": "2025-04-16T12:00:00.000Z"
}
],
"approval_status": "APPROVED",
"approved_at": "2025-04-16T17:05:31.000Z",
"comment": "Sprint planning & code review",
"custom_fields": {},
"integration_fields": [],
"changed_at": "2022-08-07T14:01:29.196Z",
"remote_deleted_at": null,
"remote_data": {}
}
]
}
]
}
},
"required": [
"status",
"data"
]
}