Skip to main content
GET
Get Employee Check Incidences

Authorizations

Authorization
string
header
required

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

Path Parameters

employeeId
string<uuid>
required

The ID of the employee

Query Parameters

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

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