GET /users

Retrieve all users for a given company.

Query parameters

  • companyID integer Required

Responses

  • 200 application/json

    List of users

    Hide response attributes Show response attributes object
    • userID integer
    • firstName string
    • lastName string
    • streetAddress string
    • route string
    • city string
    • state string
    • postalCode string
    • contactNumber string
    • email string(email)
    • role string
    • companyID integer
    • isAdmin boolean
    • statusId integer
  • 500

    Error occurred while retrieving users

GET /users
curl \
 -X GET http://api.example.com/users?companyID=42
Response examples (200)
[
  {
    "userID": 42,
    "firstName": "string",
    "lastName": "string",
    "streetAddress": "string",
    "route": "string",
    "city": "string",
    "state": "string",
    "postalCode": "string",
    "contactNumber": "string",
    "email": "hello@example.com",
    "role": "string",
    "companyID": 42,
    "isAdmin": true,
    "statusId": 42
  }
]