Gets a paginated list of users within the company

Changed on
get/v1/users

Request

  • Base URL
    https://api.nectarhr.com
  • URL
    https://api.nectarhr.com/v1/users
  • Auth
    HTTP bearer

Query parameters

expandstring[]

Return each users' expanded data

activeboolean
invitedboolean
emailstring
employee_idstring
cursorstring
limitnumber

Response

OK

status'success'

Example response

{
  "data": {
    "users": [
      {
        "phone_number": "123-456-7890"
      }
    ]
  }
}

Changes

    • info

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