GET /client

Retrieve details of a client or search for clients based on given criteria.

Query parameters

  • companyID integer Required
  • clientID integer

Responses

  • 200 application/json

    A list of clients

    Hide response attributes Show response attributes object
    • clientID integer
    • FirstName string
    • LastName string
    • Company string
    • Phone string
    • Email string
    • isActive boolean
    • CustomerSince string
    • companyID integer
    • createdBy integer
    • updatedBy integer
  • 500

    Internal Server Error

GET /client 
curl \
 -X GET http://api.example.com/client?companyID=42
Response examples (200) 
[
  {
    "clientID": 42,
    "FirstName": "string",
    "LastName": "string",
    "Company": "string",
    "Phone": "string",
    "Email": "string",
    "isActive": true,
    "CustomerSince": "string",
    "companyID": 42,
    "createdBy": 42,
    "updatedBy": 42
  }
]