List customers

GET/customers/list

Returns a list of customers.

Request

curl --request GET \
  --url 'https://9iq81tsdy4.execute-api.sa-east-1.amazonaws.com/customers/list' \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'x-api-secret: YOUR_API_SECRET' \
  --header 'business-id: YOUR_BUSINESS_ID'

const response = await fetch('https://9iq81tsdy4.execute-api.sa-east-1.amazonaws.com/customers/list', {
  method: 'GET',
  headers: {
    'x-api-key': 'YOUR_API_KEY',
    'x-api-secret': 'YOUR_API_SECRET',
    'business-id': 'YOUR_BUSINESS_ID',
  },
});

const data = await response.json();
console.log(data);

import requests

url = "https://9iq81tsdy4.execute-api.sa-east-1.amazonaws.com/customers/list"
headers = {
    "x-api-key": "YOUR_API_KEY",
    "x-api-secret": "YOUR_API_SECRET",
    "business-id": "YOUR_BUSINESS_ID",
}

response = requests.get(url, headers=headers)
print(response.json())

Response

{
  "statusCode": 200,
  "data": {
    "docs": [
      {
        "id": "6650f1a2b3c4d5e6f7a8b9c0",
        "createdAt": "2026-01-15T12:00:00.000Z",
        "updatedAt": "2026-01-15T12:00:00.000Z",
        "deleted": false,
        "name": "Maria Silva",
        "businessId": "8b1d2f4e-5a6c-4e7f-9a0b-1c2d3e4f5a6b",
        "userId": "3c4d5e6f-7a8b-4c9d-8e0f-1a2b3c4d5e6f",
        "email": "maria@example.com",
        "phone": {
          "areaCode": "+55",
          "ddd": "11",
          "number": "912345678",
          "isMobile": true
        },
        "address": {
          "zipCode": "01001000",
          "street": "Rua Exemplo",
          "number": "100",
          "complement": "Apto 12",
          "neighborhood": "Centro",
          "city": "São Paulo",
          "state": "SP"
        },
        "deliveryAddress": {
          "zipCode": "01001000",
          "street": "Rua Exemplo",
          "number": "100",
          "complement": "Apto 12",
          "neighborhood": "Centro",
          "city": "São Paulo",
          "state": "SP"
        },
        "document": {
          "type": "CPF",
          "number": "12345678909"
        }
      }
    ],
    "limit": 1,
    "currentPage": 1,
    "hasNext": true,
    "nextPage": 2,
    "totalDocs": 5,
    "totalPages": 5
  }
}

{
  "message": "Invalid param: []",
  "error": "Bad Request",
  "statusCode": 400,
  "errorCode": "string"
}

Generated from the schema

{
  "message": "Unauthorized",
  "error": "Unauthorized",
  "statusCode": 401
}

Generated from the schema

{
  "message": "Forbidden resource",
  "error": "Forbidden",
  "statusCode": 403
}

Generated from the schema

{
  "statusCode": 500,
  "message": "Internal Server Error"
}

Generated from the schema

Headers

x-api-keystringrequired
Api key provided on integrations tab in Easyflow platform.
x-api-secretstringrequired
Api Secret provided on integrations tab in Easyflow platform.
business-idstringrequired
Business Identifier

Query parameters

emailstring
Returns customers whose email is exactly this value, ignoring case. Characters with a special meaning in regular expressions, such as ., +, * or (, are not escaped and change the comparison, so a value with them can return other customers or none. A value that is not a valid regular expression returns 500.
documentNumberstring
namestring
Returns customers whose name is exactly this value, ignoring case. Characters with a special meaning in regular expressions, such as ., +, * or (, are not escaped and change the comparison, so a value with them can return other customers or none. A value that is not a valid regular expression, such as an unmatched (, returns 500.
fieldstring
Free search. Matches part of the name or email (ignoring case), part of the document number (digits only) or the customer id.
createdAt[startsAt]string
createdAt[endsAt]string
updatedAt[startsAt]string
updatedAt[endsAt]string
pageinteger
Page number. Defaults to 1.

Default:1
limitinteger
Number of items per page. Defaults to 25.

Default:25