contracts

Find contracts

Retrieves a list of all resources from the service.

get/contracts

Request

Base URL: https://api.hoorayhr.io
URL: https://api.hoorayhr.io/contracts
Auth: API key in header authorization

Response

success

idinteger

ID of the contract

userIdinteger

Unique id of the user.

userIdApprovedinteger nullable

Unique id of the user that added the contract

contractStartDatestring date

Start date of the contract in ISO Date format

contractEndDatestring date nullable

End date of the contract in ISO Date format

probationEndDatestring date nullable

End date of the probation period of the contract

signedContractinteger nullable

Tiny-int indicating if the contract has been signed.

notesstring long-text nullable

Optional text field for remarks about the contract

labelIdsinteger[]

List of id's belonging to labels

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

Status of the contract

typeinteger

The type of contract. 1 = fixed-term, 2 = permanent, 3 = internship

createdAtstring date-time

Creation date of the contract

updatedAtstring date-time

Last updated date of the contract

Example response

[
  {
    "id": 5,
    "userId": 1,
    "userIdApproved": 52,
    "contractStartDate": "2022-02-15",
    "contractEndDate": "2022-07-15",
    "probationEndDate": "2022-02-28",
    "signedContract": 1,
    "notes": "Important transfer cases",
    "labelIds": [],
    "labels": [
      {
        "id": 5,
        "name": "Long term leave",
        "type": "LEAVE",
        "systemCategoryType": "car",
        "createdAt": "2022-02-23T14:01:17.516Z",
        "updatedAt": "2022-02-23T14:01:17.516Z"
      }
    ],
    "status": "ACTIVE",
    "type": 2,
    "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.