employment-term-assignments

Get a single employment term assignment

Retrieves a single resource with the given id from the service.

get/employment-term-assignments/{id}

Request

  • Base URL: https://api.hoorayhr.io
  • URL: https://api.hoorayhr.io/employment-term-assignments/{id}
  • Auth: API key in header authorization

Path parameters

idinteger required

ID of employment-term-assignments to return

Response

success

idinteger

Unique id of the employment term assignment

userIdinteger

The user the employment term is assigned to

employmentTermIdinteger

The ID of the employment term

startDatestring date

The start date of the employment term assignment. Or the termination date, if isTerminated is set to true

currencystring nullable

A ISO 4217 string indicating the currency of the employment term assignment. It's only required for employment terms of type 'CURRENCY'.

isTerminatedboolean

Whether the employment term assignment is terminated

status'INACTIVE' | 'ACTIVE' | 'FUTURE'

Status of the employment term assignment. Assignments that start in the future have status FUTURE. All other assignments are ACTIVE, unless they either precede another assignment, or if the user's employment has finished, in which case they are INACTIVE.

salarySubTypeIdinteger nullable

The salary sub type ID the employment term assignment is linked to. Only applicable for assignments linked to the SALARY system employment term. See the salarySubTypes list on the salary employment term for a list of possible values

notestring nullable

Optional note for the employment term assignment

createdAtstring date-time

Creation date of the employment term assignment

updatedAtstring date-time

Last updated date of the employment term assignment

Example response

{
  "id": 1,
  "userId": 14,
  "employmentTermId": 16,
  "startDate": "2025-09-20",
  "currency": "EUR",
  "value": "XL",
  "status": "ACTIVE",
  "salarySubTypeId": 4,
  "createdAt": "2022-02-15T14:01:17.516Z",
  "updatedAt": "2022-02-23T14:01:17.516Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.