Skip to main content

Get all clients details

GET /api/v1/Clients/get-all

Description​

This endpoint is used to retrieve information about all clients.

Request​

Headers

  • None

ApiKey

No API key required

Content-Type​

  • text/plain

  • application/json

  • text/json

Query Parameters​
  • version: string, required
Request Body​

No request body is required

URL​

{{baseUrl API url}}/api/v{version}/Clients/get-all

Response​

A JSON array containing information about all clients.

Error Codes​

  • 400: Bad Request

  • 404: Resource not found

  • 500: Internal server error

Example​

Plain Text​
/api/v1/Clients/get-all
Response​
HTTP/1.1 200 OK
[
  {
    "ClientId": 12345,
    "Name": "John Doe",
    "Email": "john.doe@example.com",
    "Phone": "123-456-7890",
    "Address": {
      "Street": "123 Main St",
      "City": "Anytown",
      "State": "CA",
      "Zip": "12345"
    }
  },
  {
    "ClientId": 67890,
    "Name": "Jane Doe",
    "Email": "jane.doe@example.com",
    "Phone": "123-456-7891",
    "Address": {
      "Street": "123 Oak St",
      "City": "Anytown",
      "State": "CA",
      "Zip": "12345"
    }
  }
]

/api/v`{{version}}`/Clients/get-all

Headers​

Content-TypeValue
Accept-Language

Response: 200​

LANGUAGE

AUTHORIZATION

Bearer

CURL REQUEST

curl --request GET \ 
 --url  /api/v1/Clients/get-all \ 
 --header 'accept: application/json' \ 
 --header 'content-type: application/json'

RESPONSE

Click Try It! to start a request and see the response here!