Retrieve a list of employee dependants

GET 
/odata/v2/EmployeeDependant

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 [

employeeId stringnullable

nameFirstName stringnullable

nameMiddleName stringnullable

nameLastName stringnullable

nameFullName stringnullable

salutation int32

nickName stringnullable

relationship int32

addressStreet stringnullable

addressCity stringnullable

addressStateProvince stringnullable

addressZipPostalCode stringnullable

addressCountryRegion stringnullable

addressAddress stringnullable

birthDate date-timenullable

gender int32

homePhoneNumberCountryName stringnullable

homePhoneNumberCityAreaCode stringnullable

homePhoneNumberLocalNumber stringnullable

homePhoneNumberExtension stringnullable

homePhoneNumberFullPhoneNumber stringnullable

workPhoneNumberCountryName stringnullable

workPhoneNumberCityAreaCode stringnullable

workPhoneNumberLocalNumber stringnullable

workPhoneNumberExtension stringnullable

workPhoneNumberFullPhoneNumber stringnullable

mobilePhoneNumberCountryName stringnullable

mobilePhoneNumberCityAreaCode stringnullable

mobilePhoneNumberLocalNumber stringnullable

mobilePhoneNumberExtension stringnullable

mobilePhoneNumberFullPhoneNumber stringnullable

email stringnullable

priority int32

rowNumber int32

createdBy stringnullable

createdDateTime date-time

modifiedBy stringnullable

modifiedDateTime date-timenullable

versionStamp int32

documentsExists boolean

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

]

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

Example (from schema)

{
  "value": [
    {
      "employeeId": "string",
      "nameFirstName": "string",
      "nameMiddleName": "string",
      "nameLastName": "string",
      "nameFullName": "string",
      "salutation": 0,
      "nickName": "string",
      "relationship": 0,
      "addressStreet": "string",
      "addressCity": "string",
      "addressStateProvince": "string",
      "addressZipPostalCode": "string",
      "addressCountryRegion": "string",
      "addressAddress": "string",
      "birthDate": "2026-03-25T15:10:39.465Z",
      "gender": 0,
      "homePhoneNumberCountryName": "string",
      "homePhoneNumberCityAreaCode": "string",
      "homePhoneNumberLocalNumber": "string",
      "homePhoneNumberExtension": "string",
      "homePhoneNumberFullPhoneNumber": "string",
      "workPhoneNumberCountryName": "string",
      "workPhoneNumberCityAreaCode": "string",
      "workPhoneNumberLocalNumber": "string",
      "workPhoneNumberExtension": "string",
      "workPhoneNumberFullPhoneNumber": "string",
      "mobilePhoneNumberCountryName": "string",
      "mobilePhoneNumberCityAreaCode": "string",
      "mobilePhoneNumberLocalNumber": "string",
      "mobilePhoneNumberExtension": "string",
      "mobilePhoneNumberFullPhoneNumber": "string",
      "email": "string",
      "priority": 0,
      "rowNumber": 0,
      "createdBy": "string",
      "createdDateTime": "2026-03-25T15:10:39.465Z",
      "modifiedBy": "string",
      "modifiedDateTime": "2026-03-25T15:10:39.465Z",
      "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:39.465Z",
        "seniorityDate": "2026-03-25T15:10:39.465Z",
        "terminatedDate": "2026-03-25T15:10:39.465Z",
        "position": {
          "positionId": "string",
          "employeeId": "string",
          "title": "string",
          "locationId": "string",
          "organizationId": "string",
          "employmentCategoryName": "string",
          "dimension1Id": "string",
          "dimension2Id": "string",
          "dimension3Id": "string",
          "dimension4Id": "string",
          "externalReference": "string"
        }
      }
    }
  ],
  "@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...