labels

Get label

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

get/labels/{id}

Request

  • Base URL: https://api.hoorayhr.io
  • URL: https://api.hoorayhr.io/labels/{id}
  • Auth: API key in header authorization

Path parameters

idinteger required

ID of labels to return

Response

success

idinteger

ID of the label

documentCategoryIdinteger nullable

ID of the parent document category

workflowCategoryIdinteger nullable

ID of the parent workflow category

type'ASSETS' | 'CONTRACTS' | 'DOCUMENTS' | 'EXPENSE_CLAIMS' | 'HOURS' | 'LEAVE' | 'SICK_LEAVE_PHASE' | 'TIME_TRACKING' | 'TRAVEL_EXPENSES' | 'WORKFLOWS' required

Enum of the service the label is assigned to

systemCategoryType'car' | 'computer' | 'key' | 'tablet' | 'cell phone' | 'license' | 'fixed-term' | 'internship' | 'permanent' | 'parking costs' | 'food and drinks' | 'promotional gift' | 'office supplies' | 'cost of studies' | 'travel expenses' | 'commuting' | 'customer visit' | 'conference' nullable

System pre-defined labels get type

archivedAtstring date-time nullable

Timestamp of label being archived

createdAtstring date-time

Creation date of the label

updatedAtstring date-time

Last updated date of the label

deletedAtstring date-time nullable

Deleted date of the label

Example response

{
  "id": 5,
  "name": "Long term leave",
  "type": "LEAVE",
  "systemCategoryType": "car",
  "createdAt": "2022-02-23T14:01:17.516Z",
  "updatedAt": "2022-02-23T14:01:17.516Z"
}

Changes

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