Employees

Gets a list of an Employee's Entitlements.

Changed on Nov 10, 2026

get/employees/{id}/entitlements

Request

Base URL
https://api.iris.co.uk/hr/v2
Auth
OAuth 2
Client credentials
Token URLhttps://api.iris.co.uk/oauth2/v1/token
TypeScript
https://skmtc.dev/hrapi/apis/hr-api/docs/employees/:id/entitlements/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

idstring required

Employee ID.

Query parameters

$topinteger

Show only the first n items, maximum of 250, see Paging - Top

$skipinteger

Skip the first n items, see Paging - Skip

$filterstring

Filter items by property values, see Filtering

$selectstring[]

Select properties to be returned, see Select

$orderbystring

Order items by property values, see Sorting

$countboolean

Include count of items, see Count

Response

@odata.contextstring nullable

@odata.countinteger nullable

@odata.nextlinkstring nullable

Changes

Nov 10, 2026638d402d3872 Revision changes
- breaking
  added the pattern ^[0-9a-fA-F-]{36}$ to the path request parameter id
- warning
  for the path request parameter id, the maxLength was set to 36
- warning
  for the query request parameter $filter, the maxLength was set to 2000
- warning
  for the query request parameter $skip, the max was set to 2147483647.00
Oct 6, 20267a4734dbe370 Revision changes
- info
  media type application/json; version=2 was changed to application/json for the response status
- info
  media type application/json; version=2 was changed to application/json for the response status
- info
  media type application/json; version=2 was changed to application/json for the response status
- info
  media type application/json;odata.metadata=full; version=2 was changed to application/json;odata.metadata=full for the response status
- info
  media type application/json;odata.metadata=full; version=2 was changed to application/json;odata.metadata=full for the response status
- info
  media type application/json;odata.metadata=full; version=2 was changed to application/json;odata.metadata=full for the response status
- info
  media type application/json;odata.metadata=full;odata.streaming=false; version=2 was changed to application/json;odata.metadata=full;odata.streaming=false for the response status
- info
  media type application/json;odata.metadata=full;odata.streaming=false; version=2 was changed to application/json;odata.metadata=full;odata.streaming=false for the response status
- info
  media type application/json;odata.metadata=full;odata.streaming=false; version=2 was changed to application/json;odata.metadata=full;odata.streaming=false for the response status
- info
  media type application/json;odata.metadata=full;odata.streaming=true; version=2 was changed to application/json;odata.metadata=full;odata.streaming=true for the response status
- info
  media type application/json;odata.metadata=full;odata.streaming=true; version=2 was changed to application/json;odata.metadata=full;odata.streaming=true for the response status
- info
  media type application/json;odata.metadata=full;odata.streaming=true; version=2 was changed to application/json;odata.metadata=full;odata.streaming=true for the response status
- info
  media type application/json;odata.metadata=minimal; version=2 was changed to application/json;odata.metadata=minimal for the response status
- info
  media type application/json;odata.metadata=minimal; version=2 was changed to application/json;odata.metadata=minimal for the response status
- info
  media type application/json;odata.metadata=minimal; version=2 was changed to application/json;odata.metadata=minimal for the response status
- info
  media type application/json;odata.metadata=minimal;odata.streaming=false; version=2 was changed to application/json;odata.metadata=minimal;odata.streaming=false for the response status
- info
  media type application/json;odata.metadata=minimal;odata.streaming=false; version=2 was changed to application/json;odata.metadata=minimal;odata.streaming=false for the response status
- info
  media type application/json;odata.metadata=minimal;odata.streaming=false; version=2 was changed to application/json;odata.metadata=minimal;odata.streaming=false for the response status
- info
  media type application/json;odata.metadata=minimal;odata.streaming=true; version=2 was changed to application/json;odata.metadata=minimal;odata.streaming=true for the response status
- info
  media type application/json;odata.metadata=minimal;odata.streaming=true; version=2 was changed to application/json;odata.metadata=minimal;odata.streaming=true for the response status
- info
  media type application/json;odata.metadata=minimal;odata.streaming=true; version=2 was changed to application/json;odata.metadata=minimal;odata.streaming=true for the response status
- info
  media type application/json;odata.metadata=none; version=2 was changed to application/json;odata.metadata=none for the response status
- info
  media type application/json;odata.metadata=none; version=2 was changed to application/json;odata.metadata=none for the response status
- info
  media type application/json;odata.metadata=none; version=2 was changed to application/json;odata.metadata=none for the response status
- info
  media type application/json;odata.metadata=none;odata.streaming=false; version=2 was changed to application/json;odata.metadata=none;odata.streaming=false for the response status
- info
  media type application/json;odata.metadata=none;odata.streaming=false; version=2 was changed to application/json;odata.metadata=none;odata.streaming=false for the response status
- info
  media type application/json;odata.metadata=none;odata.streaming=false; version=2 was changed to application/json;odata.metadata=none;odata.streaming=false for the response status
- info
  media type application/json;odata.metadata=none;odata.streaming=true; version=2 was changed to application/json;odata.metadata=none;odata.streaming=true for the response status
- info
  media type application/json;odata.metadata=none;odata.streaming=true; version=2 was changed to application/json;odata.metadata=none;odata.streaming=true for the response status
- info
  media type application/json;odata.metadata=none;odata.streaming=true; version=2 was changed to application/json;odata.metadata=none;odata.streaming=true for the response status
- info
  media type application/json;odata.streaming=false; version=2 was changed to application/json;odata.streaming=false for the response status
- info
  media type application/json;odata.streaming=false; version=2 was changed to application/json;odata.streaming=false for the response status
- info
  media type application/json;odata.streaming=false; version=2 was changed to application/json;odata.streaming=false for the response status
- info
  media type application/json;odata.streaming=true; version=2 was changed to application/json;odata.streaming=true for the response status
- info
  media type application/json;odata.streaming=true; version=2 was changed to application/json;odata.streaming=true for the response status
- info
  media type application/json;odata.streaming=true; version=2 was changed to application/json;odata.streaming=true for the response status
- info
  media type application/xml; version=2 was changed to application/xml for the response status
- info
  media type application/xml; version=2 was changed to application/xml for the response status
- info
  media type application/xml; version=2 was changed to application/xml for the response status
- info
  media type text/plain; version=2 was changed to text/plain for the response status
- info
  media type text/plain; version=2 was changed to text/plain for the response status
- info
  media type text/plain; version=2 was changed to text/plain for the response status

Operation history (3 revisions)