HUhurma
Employees

List employees

Changed on

Handle HTTP requests regarding Customers.

get/employees

Request

Query parameters

statusinteger

7 - employees on a probationary period, 8 - current and fired employees, 9 - current employees (including employees on probation)

emailstring
started_work_fromstring

Format Y-m-d

started_work_tostring

Format Y-m-d

finished_work_fromstring

Format Y-m-d

finished_work_tostring

Format Y-m-d

pageinteger
per_pageinteger

Headers

tokenstring required

Api token

Response

ОК

errorboolean
codeinteger
messagesstring[]

Example response

{
  "result": {
    "current_page": 1,
    "data": [
      {
        "id": "Yu",
        "name": "John Smith",
        "email": "Employee@email.com",
        "position": "HR"
      }
    ],
    "first_page_url": "https://hurma.work/api/path?page=1",
    "from": 1,
    "last_page": 1,
    "last_page_url": "https://hurma.work/api/path?page=1",
    "next_page_url": "https://hurma.work/api/path?page=1",
    "path": "https://hurma.work/api/path",
    "per_page": 12,
    "to": 4,
    "total": 4
  },
  "code": 200
}

Changes

  • c2e35a68e512Revision changes
    • info

      api operation id 1dce49c8aac6c9a42fcfcc681935049d was added

    • info

      added the new optional query request parameter email

    • info

      added the new optional query request parameter finished_work_from

    • info

      added the new optional query request parameter finished_work_to

    • info

      added the new optional query request parameter started_work_from

    • info

      added the new optional query request parameter started_work_to

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status