Skip to main content
GET
/
clients
List Clients
curl --request GET \
  --url https://api.example.com/clients
{
  "error": false,
  "listClients": [
    {
      "id": "036c71c5-14e0-11f1-9fcd-2418c6c96a00",
      "name": "Mark Zuckemberg",
      "email": "[email protected]"
    },
    {
      "id": "49a5ddf8-14ce-11f1-9fcd-2418c6c96a00",
      "name": "albert Epstein",
      "email": "[email protected]"
    }
  ]
}
This endpoint returns a list of all clients registered in the system.

​
Response

​
error
boolean
Indicates if there was an error (always false on success)
​
listClients
array
Array of client objects

​
Response Example

{
  "error": false,
  "listClients": [
    {
      "id": "036c71c5-14e0-11f1-9fcd-2418c6c96a00",
      "name": "Mark Zuckemberg",
      "email": "[email protected]"
    },
    {
      "id": "49a5ddf8-14ce-11f1-9fcd-2418c6c96a00",
      "name": "albert Epstein",
      "email": "[email protected]"
    }
  ]
}

Build docs developers (and LLMs) love

Get started for freeTalk to us