Get Employees

GET /employee

Get all employees, even fired ones.

Responses

  • 200 application/json

    Successful employee retrieval.

    Hide response attributes Show response attributes object
    • success boolean

      Whether the retrieval is successful

    • employee array[object]
      Hide employee attributes Show employee attributes object
      • client_id integer Required

        Id of the client in database

      • created_at string(date) Required

        Account creation date

      • email_address string Required

        Client's email address

      • first_name string Required

        Client's first name

      • last_name string Required

        Client's last name

      • patronymic string Required

        Client's patronymic/middle name

      • phone_number string Required

        Client's phone number

      • profile_picture_url string Required

        Link to client's profile picture, typically uploaded using POST /profile-picture

      • employee_id integer Required

        Id of the employee in database

      • employee_type string Required

        Employee's current job posting

        Values are ADMIN, INSTRUCTOR, or TRAINER.

      • left_at string(date) Required

        Employee's firing date (null if employee wasn't fired yet)

  • 401 application/json

    User is not unauthorized or permissions are missing.

    Hide response attributes Show response attributes object
  • 429 application/json

    Rate limit exceeded - 100 queries per 15 minutes.

    Hide response attributes Show response attributes object
GET /employee
curl \
 -X GET http://63.141.232.244:25540/v0/employee \
 -H "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200)
{
  "success": true,
  "employee": [
    {
      "left_at": null,
      "client_id": 1,
      "employee_id": 1,
      "employee_type": "ADMIN"
    }
  ]
}
Response examples (401)
{
  "success": false,
  "error": "Unauthorized"
}
Response examples (429)
{
  "success": false,
  "error": "Too many requests, please try again later"
}