Skip to main content
GET
/
schedule
/
v1
/
check-incidences
List Company Check Incidences
curl --request GET \
  --url https://api-{region}.sesametime.com/schedule/v1/check-incidences \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "employeeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "createdAt": "2020-01-01T10:00:00+01:00",
      "updatedAt": "2020-01-01T10:00:00+01:00",
      "employee": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "firstName": "Lucas",
        "lastName": "García",
        "secondLastName": "<string>",
        "email": "jsmith@example.com",
        "imageProfileURL": "https://sesame-v2-prod-companies.s3.eu-west-3.amazonaws.com/48351485-1659-413d-bf7f-3ca34fadb521/public-read/g892f1fb-55a3-4e32-9cc9-7c19faa70gaa.png",
        "code": 1,
        "pin": 1000,
        "phone": "+34 111 11 11 11",
        "company": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "notificationEmail": "jsmith@example.com",
          "language": "<string>",
          "createdAt": "2020-01-01T10:00:00+01:00",
          "updatedAt": "2020-01-01T10:00:00+01:00"
        },
        "contractId": "<string>",
        "nid": "<string>",
        "secondaryNid": "<string>",
        "ssn": "<string>",
        "pricePerHour": 123,
        "accountNumber": "<string>",
        "dateOfBirth": "2023-12-25",
        "customFields": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "name": "<string>",
            "slug": "<string>",
            "type": "<string>",
            "value": "<string>",
            "createdAt": "2020-01-01T10:00:00+01:00",
            "updatedAt": "2020-01-01T10:00:00+01:00"
          }
        ],
        "createdAt": "2020-01-01T10:00:00+01:00",
        "updatedAt": "2020-01-01T10:00:00+01:00",
        "children": 2,
        "disability": 25,
        "address": "<string>",
        "postalCode": "<string>",
        "city": "<string>",
        "province": "<string>",
        "country": "ES",
        "nationality": "ES",
        "nationalities": [
          "ES",
          "FR"
        ],
        "personalMail": "jsmith@example.com",
        "maritalStatus": "<string>",
        "emergencyPhone": "<string>",
        "description": "<string>",
        "salaryRange": "<string>",
        "studyLevel": "<string>",
        "professionalCategoryCode": "<string>",
        "professionalCategoryDescription": "<string>",
        "bic": "<string>",
        "jobChargeId": "<string>",
        "jobChargeName": "<string>",
        "jobChargeDescription": "<string>",
        "jobChargeCompetencies": "<string>",
        "language": "es-ES",
        "workPhone": "+34 111 11 11 11",
        "mainRecruiter": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "firstName": "Lucas",
          "lastName": "García",
          "secondLastName": "<string>",
          "imageProfileURL": "https://sesame-v2-prod-companies.s3.eu-west-3.amazonaws.com/48351485-1659-413d-bf7f-3ca34fadb521/public-read/g892f1fb-55a3-4e32-9cc9-7c19faa70gaa.png",
          "email": "jsmith@example.com",
          "workCheckTypeColor": "#FF0000",
          "workCheckTypeName": "Remote"
        },
        "nfc": "<string>",
        "contributionGroupId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      },
      "checkType": "<string>",
      "checkIncidenceSentNotificationMail": "2020-01-01T10:00:00+01:00",
      "checkIncidenceSentNotificationPanel": "2020-01-01T10:00:00+01:00",
      "check": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "employeeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "accumulatedSeconds": 123,
        "checkType": "<string>",
        "hasDocument": true,
        "isRemote": true,
        "workBreakId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "workBreak": {},
        "workCheckType": {},
        "incidence": {},
        "metadata": {},
        "checkIn": {
          "canEdit": true,
          "coordinates": {
            "latitude": 123,
            "longitude": 123
          },
          "date": "2020-01-01T10:00:00+01:00",
          "deviceId": "<string>",
          "deviceName": "<string>",
          "insideOffice": true,
          "ip": "<string>",
          "isSuprema": true,
          "officeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "officeName": "<string>",
          "origin": "<string>",
          "performedByEmployeeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "performedByEmployeeImageProfile": "<string>",
          "performedByEmployeeName": "<string>",
          "realDate": "2020-01-01T10:00:00+01:00",
          "timezone": "<string>"
        },
        "checkOut": {
          "canEdit": true,
          "coordinates": {
            "latitude": 123,
            "longitude": 123
          },
          "date": "2020-01-01T10:00:00+01:00",
          "deviceId": "<string>",
          "deviceName": "<string>",
          "insideOffice": true,
          "ip": "<string>",
          "isSuprema": true,
          "officeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "officeName": "<string>",
          "origin": "<string>",
          "performedByEmployeeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "performedByEmployeeImageProfile": "<string>",
          "performedByEmployeeName": "<string>",
          "realDate": "2020-01-01T10:00:00+01:00",
          "timezone": "<string>"
        },
        "createdAt": "2020-01-01T10:00:00+01:00",
        "updatedAt": "2020-01-01T10:00:00+01:00",
        "deletedAt": "2020-01-01T10:00:00+01:00"
      },
      "checkData": {
        "canEdit": true,
        "coordinates": {
          "latitude": 123,
          "longitude": 123
        },
        "date": "2020-01-01T10:00:00+01:00",
        "deviceId": "<string>",
        "deviceName": "<string>",
        "insideOffice": true,
        "ip": "<string>",
        "isSuprema": true,
        "officeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "officeName": "<string>",
        "origin": "<string>",
        "performedByEmployeeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "performedByEmployeeImageProfile": "<string>",
        "performedByEmployeeName": "<string>",
        "realDate": "2020-01-01T10:00:00+01:00",
        "timezone": "<string>"
      },
      "metadata": {}
    }
  ],
  "meta": {
    "currentPage": 1,
    "lastPage": 1,
    "total": 1,
    "perPage": 1
  }
}

Documentation Index

Fetch the complete documentation index at: https://apidocs.sesametime.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
employeeId
string<uuid>

Filter by employee ID

​
employeeIds[in]
string<uuid>[]

Filter by multiple employee IDs

​
checkIncidenceStatus[in]
enum<string>[]

Filter by check incidence status

Available options:
pending,
revised
​
checkIncidenceType[in]
string[]

Filter by check incidence type

​
checkType[in]
string[]

Filter by check type

​
resolverRole[in]
string[]

Filter by resolver role

​
sentNotificationMail[null]
boolean

Filter by notification mail sent status

​
sentNotificationPanel[null]
boolean

Filter by notification panel sent status

​
fromDate[gte]
string<date>

Filter incidences where checkData.date is on or after this date. Format: YYYY-MM-DD

​
toDate[lte]
string<date>

Filter incidences where checkData.date is on or before this date. Format: YYYY-MM-DD

​
createdAt[gte]
string<Y-m-dTH:i:sP>

Filter by created date from

Example:

"2020-01-01T10:00:00+01:00"

​
createdAt[lte]
string<Y-m-dTH:i:sP>

Filter by created date to

Example:

"2020-01-01T10:00:00+01:00"

​
updatedAt[gte]
string<Y-m-dTH:i:sP>

Filter by updated date from

Example:

"2020-01-01T10:00:00+01:00"

​
updatedAt[lte]
string<Y-m-dTH:i:sP>

Filter by updated date to

Example:

"2020-01-01T10:00:00+01:00"

​
limit
integer
default:20

Number of items per page

​
page
integer
default:1

Page number

​
orderBy
string

Order results by field(s). Example: createdAt asc, updatedAt desc

Response

200 - application/json

List of Check Incidences

​
data
object[]
​
meta
object