Retrieve a list of leave groups

GET 
/odata/v2/LeaveGroup

Response is limited to 3000 records. Follow '@odata.nextLink' to retrieve the next page.

Request

Query Parameters

$skip number

Skip N. See https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionskip

Responses

200

OK

application/json

Schema

Schema

value

object[]

nullable

required

Array [

leaveGroupName stringnullable

rowNumber int32

createdBy stringnullable

createdDateTime date-time

modifiedBy stringnullable

modifiedDateTime date-timenullable

versionStamp int32

documentsExists boolean

leaveCodes

object[]

nullable

Array [

leaves

object[]

nullable

Array [

integrations

object[]

nullable

Array [

leaveId stringnullable

version int32

leaveCodeName stringnullable

startDate date-time

endDate date-time

balanceEffect double

balanceUnit int32

employeeId stringnullable

origin int32

payrollUpdateStatus int32

payrollDateTime date-timenullable

correction boolean

rowNumber int32

createdBy stringnullable

createdDateTime date-time

modifiedBy stringnullable

modifiedDateTime date-timenullable

versionStamp int32

documentsExists boolean

externalStatus int32

employee

object

employeeId stringnullable

externalReference stringnullable

initials stringnullable

email stringnullable

nameFirstName stringnullable

nameMiddleName stringnullable

nameLastName stringnullable

nameFullName stringnullable

hiredDate date-timenullable

seniorityDate date-timenullable

terminatedDate date-timenullable

position

object

positionId stringnullable

employeeId stringnullable

title stringnullable

locationId stringnullable

organizationId stringnullable

employmentCategoryName stringnullable

dimension1Id stringnullable

dimension2Id stringnullable

dimension3Id stringnullable

dimension4Id stringnullable

externalReference stringnullable

]

leaveId stringnullable

employeeId stringnullable

approvalStatus int32

approvedDateTime date-timenullable

approver stringnullable

submitter stringnullable

leaveCodeName stringnullable

quantity double

description stringnullable

origin int32

halfDay boolean

rowNumber int32

createdBy stringnullable

createdDateTime date-time

modifiedBy stringnullable

modifiedDateTime date-timenullable

versionStamp int32

documentsExists boolean

batchId stringnullable

leaveLines

object[]

nullable

Array [

leaveId stringnullable

transDate date-time

leaveTypePeriodId stringnullable

balanceEffect double

rowNumber int32

createdBy stringnullable

createdDateTime date-time

modifiedBy stringnullable

modifiedDateTime date-timenullable

versionStamp int32

documentsExists boolean

leaveTypePeriod

object

leaveLines undefined[]nullable

leaveType

object

leaveCodes undefined[]nullable

leaveTypeName stringnullable

rowNumber int32

createdBy stringnullable

createdDateTime date-time

modifiedBy stringnullable

modifiedDateTime date-timenullable

versionStamp int32

documentsExists boolean

balanceType int32

leaveTypePeriods undefined[]nullable

leaveTypePeriodId stringnullable

leaveTypeName stringnullable

startDateConduct date-time

endDateConduct date-time

startDateAccumulate date-timenullable

endDateAccumulate date-timenullable

status int32

rowNumber int32

createdBy stringnullable

createdDateTime date-time

modifiedBy stringnullable

modifiedDateTime date-timenullable

versionStamp int32

documentsExists boolean

]

leaveCode

employee

object

employeeId stringnullable

externalReference stringnullable

initials stringnullable

email stringnullable

nameFirstName stringnullable

nameMiddleName stringnullable

nameLastName stringnullable

nameFullName stringnullable

hiredDate date-timenullable

seniorityDate date-timenullable

terminatedDate date-timenullable

position

object

positionId stringnullable

employeeId stringnullable

title stringnullable

locationId stringnullable

organizationId stringnullable

employmentCategoryName stringnullable

dimension1Id stringnullable

dimension2Id stringnullable

dimension3Id stringnullable

dimension4Id stringnullable

externalReference stringnullable

]

leaveGroups undefined[]nullable

leaveCodeName stringnullable

color int32

leaveTypeName stringnullable

balanceUnit int32

qtyTransferMax double

qtyPayoutMax double

negativeBalance boolean

allowCreateEmployee boolean

allowCreateManager boolean

seniorityMonths int32

qtyAccumulatePeriod double

onlyFullDays boolean

rowNumber int32

createdBy stringnullable

createdDateTime date-time

modifiedBy stringnullable

modifiedDateTime date-timenullable

versionStamp int32

documentsExists boolean

active boolean

approvalWorkflow boolean

negativeBalanceMax double

lockDescription boolean

qtyAccumulateDay double

qtyAccumulatePeriodExtra double

accumulatePeriodFrequency int32

autoAccumulate boolean

periodPrinciple int32

visibleEmployeeDashboard boolean

visibleManagerDashboard boolean

visibleHrDashboard boolean

kind int32

leaveType

object

leaveCodes undefined[]nullable

leaveTypeName stringnullable

rowNumber int32

createdBy stringnullable

createdDateTime date-time

modifiedBy stringnullable

modifiedDateTime date-timenullable

versionStamp int32

documentsExists boolean

balanceType int32

leaveTypePeriods

object[]

nullable

Array [

leaveLines

object[]

nullable

Array [

leaveId stringnullable

transDate date-time

leaveTypePeriodId stringnullable

balanceEffect double

rowNumber int32

createdBy stringnullable

createdDateTime date-time

modifiedBy stringnullable

modifiedDateTime date-timenullable

versionStamp int32

documentsExists boolean

leaveTypePeriod

]

leaveType

leaveTypePeriodId stringnullable

leaveTypeName stringnullable

startDateConduct date-time

endDateConduct date-time

startDateAccumulate date-timenullable

endDateAccumulate date-timenullable

status int32

rowNumber int32

createdBy stringnullable

createdDateTime date-time

modifiedBy stringnullable

modifiedDateTime date-timenullable

versionStamp int32

documentsExists boolean

]

]

]

@odata.context stringnullable
@odata.count int32nullable
@odata.nextLink stringnullable

Example (from schema)

{
  "value": [
    {
      "leaveGroupName": "string",
      "rowNumber": 0,
      "createdBy": "string",
      "createdDateTime": "2026-03-25T15:10:38.771Z",
      "modifiedBy": "string",
      "modifiedDateTime": "2026-03-25T15:10:38.771Z",
      "versionStamp": 0,
      "documentsExists": true,
      "leaveCodes": [
        {
          "leaves": [
            {
              "integrations": [
                {
                  "leaveId": "string",
                  "version": 0,
                  "leaveCodeName": "string",
                  "startDate": "2026-03-25T15:10:38.772Z",
                  "endDate": "2026-03-25T15:10:38.772Z",
                  "balanceEffect": 0,
                  "balanceUnit": 0,
                  "employeeId": "string",
                  "origin": 0,
                  "payrollUpdateStatus": 0,
                  "payrollDateTime": "2026-03-25T15:10:38.772Z",
                  "correction": true,
                  "rowNumber": 0,
                  "createdBy": "string",
                  "createdDateTime": "2026-03-25T15:10:38.772Z",
                  "modifiedBy": "string",
                  "modifiedDateTime": "2026-03-25T15:10:38.772Z",
                  "versionStamp": 0,
                  "documentsExists": true,
                  "externalStatus": 0,
                  "employee": {
                    "employeeId": "string",
                    "externalReference": "string",
                    "initials": "string",
                    "email": "string",
                    "nameFirstName": "string",
                    "nameMiddleName": "string",
                    "nameLastName": "string",
                    "nameFullName": "string",
                    "hiredDate": "2026-03-25T15:10:38.772Z",
                    "seniorityDate": "2026-03-25T15:10:38.772Z",
                    "terminatedDate": "2026-03-25T15:10:38.772Z",
                    "position": {
                      "positionId": "string",
                      "employeeId": "string",
                      "title": "string",
                      "locationId": "string",
                      "organizationId": "string",
                      "employmentCategoryName": "string",
                      "dimension1Id": "string",
                      "dimension2Id": "string",
                      "dimension3Id": "string",
                      "dimension4Id": "string",
                      "externalReference": "string"
                    }
                  }
                }
              ],
              "leaveId": "string",
              "employeeId": "string",
              "approvalStatus": 0,
              "approvedDateTime": "2026-03-25T15:10:38.772Z",
              "approver": "string",
              "submitter": "string",
              "leaveCodeName": "string",
              "quantity": 0,
              "description": "string",
              "origin": 0,
              "halfDay": true,
              "rowNumber": 0,
              "createdBy": "string",
              "createdDateTime": "2026-03-25T15:10:38.772Z",
              "modifiedBy": "string",
              "modifiedDateTime": "2026-03-25T15:10:38.772Z",
              "versionStamp": 0,
              "documentsExists": true,
              "batchId": "string",
              "leaveLines": [
                {
                  "leaveId": "string",
                  "transDate": "2026-03-25T15:10:38.772Z",
                  "leaveTypePeriodId": "string",
                  "balanceEffect": 0,
                  "rowNumber": 0,
                  "createdBy": "string",
                  "createdDateTime": "2026-03-25T15:10:38.772Z",
                  "modifiedBy": "string",
                  "modifiedDateTime": "2026-03-25T15:10:38.772Z",
                  "versionStamp": 0,
                  "documentsExists": true,
                  "leaveTypePeriod": {
                    "leaveLines": [
                      null
                    ],
                    "leaveType": {
                      "leaveCodes": [
                        null
                      ],
                      "leaveTypeName": "string",
                      "rowNumber": 0,
                      "createdBy": "string",
                      "createdDateTime": "2026-03-25T15:10:38.772Z",
                      "modifiedBy": "string",
                      "modifiedDateTime": "2026-03-25T15:10:38.772Z",
                      "versionStamp": 0,
                      "documentsExists": true,
                      "balanceType": 0,
                      "leaveTypePeriods": [
                        null
                      ]
                    },
                    "leaveTypePeriodId": "string",
                    "leaveTypeName": "string",
                    "startDateConduct": "2026-03-25T15:10:38.772Z",
                    "endDateConduct": "2026-03-25T15:10:38.772Z",
                    "startDateAccumulate": "2026-03-25T15:10:38.772Z",
                    "endDateAccumulate": "2026-03-25T15:10:38.772Z",
                    "status": 0,
                    "rowNumber": 0,
                    "createdBy": "string",
                    "createdDateTime": "2026-03-25T15:10:38.772Z",
                    "modifiedBy": "string",
                    "modifiedDateTime": "2026-03-25T15:10:38.772Z",
                    "versionStamp": 0,
                    "documentsExists": true
                  }
                }
              ],
              "employee": {
                "employeeId": "string",
                "externalReference": "string",
                "initials": "string",
                "email": "string",
                "nameFirstName": "string",
                "nameMiddleName": "string",
                "nameLastName": "string",
                "nameFullName": "string",
                "hiredDate": "2026-03-25T15:10:38.772Z",
                "seniorityDate": "2026-03-25T15:10:38.772Z",
                "terminatedDate": "2026-03-25T15:10:38.772Z",
                "position": {
                  "positionId": "string",
                  "employeeId": "string",
                  "title": "string",
                  "locationId": "string",
                  "organizationId": "string",
                  "employmentCategoryName": "string",
                  "dimension1Id": "string",
                  "dimension2Id": "string",
                  "dimension3Id": "string",
                  "dimension4Id": "string",
                  "externalReference": "string"
                }
              }
            }
          ],
          "leaveGroups": [
            null
          ],
          "leaveCodeName": "string",
          "color": 0,
          "leaveTypeName": "string",
          "balanceUnit": 0,
          "qtyTransferMax": 0,
          "qtyPayoutMax": 0,
          "negativeBalance": true,
          "allowCreateEmployee": true,
          "allowCreateManager": true,
          "seniorityMonths": 0,
          "qtyAccumulatePeriod": 0,
          "onlyFullDays": true,
          "rowNumber": 0,
          "createdBy": "string",
          "createdDateTime": "2026-03-25T15:10:38.772Z",
          "modifiedBy": "string",
          "modifiedDateTime": "2026-03-25T15:10:38.772Z",
          "versionStamp": 0,
          "documentsExists": true,
          "active": true,
          "approvalWorkflow": true,
          "negativeBalanceMax": 0,
          "lockDescription": true,
          "qtyAccumulateDay": 0,
          "qtyAccumulatePeriodExtra": 0,
          "accumulatePeriodFrequency": 0,
          "autoAccumulate": true,
          "periodPrinciple": 0,
          "visibleEmployeeDashboard": true,
          "visibleManagerDashboard": true,
          "visibleHrDashboard": true,
          "kind": 0,
          "leaveType": {
            "leaveCodes": [
              null
            ],
            "leaveTypeName": "string",
            "rowNumber": 0,
            "createdBy": "string",
            "createdDateTime": "2026-03-25T15:10:38.772Z",
            "modifiedBy": "string",
            "modifiedDateTime": "2026-03-25T15:10:38.772Z",
            "versionStamp": 0,
            "documentsExists": true,
            "balanceType": 0,
            "leaveTypePeriods": [
              {
                "leaveLines": [
                  {
                    "leaveId": "string",
                    "transDate": "2026-03-25T15:10:38.772Z",
                    "leaveTypePeriodId": "string",
                    "balanceEffect": 0,
                    "rowNumber": 0,
                    "createdBy": "string",
                    "createdDateTime": "2026-03-25T15:10:38.772Z",
                    "modifiedBy": "string",
                    "modifiedDateTime": "2026-03-25T15:10:38.772Z",
                    "versionStamp": 0,
                    "documentsExists": true
                  }
                ],
                "leaveTypePeriodId": "string",
                "leaveTypeName": "string",
                "startDateConduct": "2026-03-25T15:10:38.772Z",
                "endDateConduct": "2026-03-25T15:10:38.772Z",
                "startDateAccumulate": "2026-03-25T15:10:38.772Z",
                "endDateAccumulate": "2026-03-25T15:10:38.772Z",
                "status": 0,
                "rowNumber": 0,
                "createdBy": "string",
                "createdDateTime": "2026-03-25T15:10:38.772Z",
                "modifiedBy": "string",
                "modifiedDateTime": "2026-03-25T15:10:38.772Z",
                "versionStamp": 0,
                "documentsExists": true
              }
            ]
          }
        }
      ]
    }
  ],
  "@odata.context": "string",
  "@odata.count": 0,
  "@odata.nextLink": "string"
}

400

Bad request. Occurs if the request payload or querystring contains invalid data

application/json

Schema

Schema

type stringnullable
title stringnullable
status int32nullable
detail stringnullable
instance stringnullable

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

401

Unauthorized

Loading...