Get All Customers

GET /customers
Authorization

Responses

  • 200
    Hide response attribute Show response attribute object
    • customers array[object] Required
      Hide customers attributes Show customers attributes array[object]
      • cuc string Required
      • document string Required
      • email string Required
      • firstName string Required
      • id string Required
      • lastName string Required
      • nickName string Required
      • phone string Required
      • status number Required
  • 400
    Hide response attributes Show response attributes object
    • message object Required
    • data object Required
  • 401
    Hide response attributes Show response attributes object
    • message object Required
    • data object Required
GET /customers 
curl \
 -X GET https://open-api.hml.soupi.com.br/customers \
 -H "Authorization: $API_KEY"
Response examples (200) 
{
  "customers": [
    {
      "cuc": "string",
      "document": "string",
      "email": "string",
      "firstName": "string",
      "id": "string",
      "lastName": "string",
      "nickName": "string",
      "phone": "string",
      "status": 42.0
    }
  ]
}
Response examples (200) 
{
  "customers": [
    {
      "cuc": "string",
      "document": "string",
      "email": "string",
      "firstName": "string",
      "id": "string",
      "lastName": "string",
      "nickName": "string",
      "phone": "string",
      "status": 42.0
    }
  ]
}
Response examples (400) 
{
  "message": {},
  "data": {}
}
Response examples (400) 
{
  "message": {},
  "data": {}
}
Response examples (401) 
{
  "message": {},
  "data": {}
}
Response examples (401) 
{
  "message": {},
  "data": {}
}