UserAbsence

User absences, such as vacation, sick leave, further training, etc.

Operations

GET/v1/user-absences/specGET/v1/user-absencesPOST/v1/user-absencesGET/v1/user-absences/{userAbsenceId}DELETE/v1/user-absences/{userAbsenceId}PATCH/v1/user-absences/{userAbsenceId}

---

OpenAPI Spec

GET

/v1/user-absences/spec

Get OpenAPI 3.1.0 spec for UserAbsence API

Responses

Returns OpenAPI 3.1.0 spec for UserAbsence API

Content-Type

application/json

{

}

GET

/v1/user-absences/spec

Playground

Samples

cURL

JavaScript

PHP

Python

---

List UserAbsences

GET

/v1/user-absences

List UserAbsences

Authorizations

apiKey

TypeHTTP (bearer)

Parameters

Query Parameters

page

Typenumber

Minimum0

Default0

size

Typenumber

Minimum1

Maximum20

Default10

typeId

startsAt

endsAt

userId

requestedAt

approvedAt

needApprovalById

declinedAt

declinedById

compensatedById

status

Typestring

Valid values

"idle""draft""approved""declined"

externalId

createdAt

updatedAt

Responses

List response

Content-Type

application/json

{

"page": 0,

"pages": 0,

"size": 10,

"items": [

{

"id": 0,

"typeId": 0,

"startsAt": "string",

"endsAt": "string",

"userId": 0,

"requestedAt": "string",

"approvedAt": "string",

"noteForApproval": "string",

"needApprovalById": 0,

"declinedAt": "string",

"declinedNote": "string",

"declinedById": 0,

"compensationApprovedAt": "string",

"compensationDeclinedAt": "string",

"compensatedById": 0,

"workDays": 0,

"status": "string",

"externalId": "string",

"createdAt": "string",

"updatedAt": "string"

}

]

}

GET

/v1/user-absences

Playground

Server

Authorization

apiKey

Variables

Key

Value

page

size

typeId

startsAt

endsAt

userId

requestedAt

approvedAt

needApprovalById

declinedAt

declinedById

compensatedById

status

externalId

createdAt

updatedAt

Samples

cURL

JavaScript

PHP

Python

---

Create a new UserAbsence

POST

/v1/user-absences

Create a new UserAbsence

Authorizations

apiKey

TypeHTTP (bearer)

Request Body

application/json

{

"typeId": 0,

"startsAt": "string",

"endsAt": "string",

"userId": 0,

"requestedAt": "string",

"approvedAt": "string",

"noteForApproval": "string",

"needApprovalById": 0,

"declinedAt": "string",

"declinedNote": "string",

"declinedById": 0,

"compensationApprovedAt": "string",

"compensationDeclinedAt": "string",

"compensatedById": 0,

"externalId": null

}

Responses

UserAbsence found

Content-Type

application/json

{

"id": 0,

"typeId": 0,

"startsAt": "string",

"endsAt": "string",

"userId": 0,

"requestedAt": "string",

"approvedAt": "string",

"noteForApproval": "string",

"needApprovalById": 0,

"declinedAt": "string",

"declinedNote": "string",

"declinedById": 0,

"compensationApprovedAt": "string",

"compensationDeclinedAt": "string",

"compensatedById": 0,

"workDays": 0,

"status": "string",

"externalId": "string",

"createdAt": "string",

"updatedAt": "string"

}

POST

/v1/user-absences

Playground

Server

Authorization

apiKey

Body

Samples

cURL

JavaScript

PHP

Python

---

Get a UserAbsence

GET

/v1/user-absences/{userAbsenceId}

Get a UserAbsence by ID

Authorizations

apiKey

TypeHTTP (bearer)

Parameters

Path Parameters

userAbsenceId*

Typeinteger

Required

Format"int32"

Responses

UserAbsence found

Content-Type

application/json

{

"id": 0,

"typeId": 0,

"startsAt": "string",

"endsAt": "string",

"userId": 0,

"requestedAt": "string",

"approvedAt": "string",

"noteForApproval": "string",

"needApprovalById": 0,

"declinedAt": "string",

"declinedNote": "string",

"declinedById": 0,

"compensationApprovedAt": "string",

"compensationDeclinedAt": "string",

"compensatedById": 0,

"workDays": 0,

"status": "string",

"externalId": "string",

"createdAt": "string",

"updatedAt": "string"

}

GET

/v1/user-absences/{userAbsenceId}

Playground

Server

Authorization

apiKey

Variables

Key

Value

userAbsenceId*

Samples

cURL

JavaScript

PHP

Python

---

Delete a UserAbsence

DELETE

/v1/user-absences/{userAbsenceId}

Delete a UserAbsence by ID

Authorizations

apiKey

TypeHTTP (bearer)

Parameters

Path Parameters

userAbsenceId*

Typeinteger

Required

Format"int32"

Responses

Successfully removed

DELETE

/v1/user-absences/{userAbsenceId}

Playground

Server

Authorization

apiKey

Variables

Key

Value

userAbsenceId*

Samples

cURL

JavaScript

PHP

Python

---

Update a UserAbsence

PATCH

/v1/user-absences/{userAbsenceId}

Update a UserAbsence by ID

Authorizations

apiKey

TypeHTTP (bearer)

Parameters

Path Parameters

userAbsenceId*

Typeinteger

Required

Format"int32"

Request Body

application/json

{

"startsAt": "string",

"endsAt": "string",

"requestedAt": "string",

"approvedAt": "string",

"noteForApproval": "string",

"needApprovalById": 0,

"declinedAt": "string",

"declinedNote": "string",

"declinedById": 0,

"compensationApprovedAt": "string",

"compensationDeclinedAt": "string",

"compensatedById": 0,

"externalId": "string"

}

Responses

UserAbsence found

Content-Type

application/json

{

"id": 0,

"typeId": 0,

"startsAt": "string",

"endsAt": "string",

"userId": 0,

"requestedAt": "string",

"approvedAt": "string",

"noteForApproval": "string",

"needApprovalById": 0,

"declinedAt": "string",

"declinedNote": "string",

"declinedById": 0,

"compensationApprovedAt": "string",

"compensationDeclinedAt": "string",

"compensatedById": 0,

"workDays": 0,

"status": "string",

"externalId": "string",

"createdAt": "string",

"updatedAt": "string"

}

PATCH

/v1/user-absences/{userAbsenceId}

Playground

Server

Authorization

apiKey

Variables

Key

Value

userAbsenceId*

Body

Samples

cURL

JavaScript

PHP

Python

---