Gets general information about a specific user

Changed on
get/v1/users/{userId}

Request

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

Path parameters

userIdstring uuid required

The id of the user to fetch data for

Query parameters

expandstring[]

Return each users' expanded data

Response

OK

status'success'

Example response

{
  "data": {
    "user": {
      "phone_number": "123-456-7890"
    }
  }
}

Changes

    • info

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

    • breaking

      for the path request parameter userId, the format changed from no format to uuid