Pular para o conteúdo principal
GET
/
api
/
partner
/
v1
/
merchant
/
customers
Listar clientes
curl --request GET \
  --url https://integracao.sandbox.cardapioweb.com/api/partner/v1/merchant/customers \
  --header 'X-API-KEY: <api-key>'
{
  "customers": [
    {
      "id": 123,
      "name": "<string>",
      "email": "jsmith@example.com",
      "phone_number": "<string>",
      "ddi": "<string>",
      "birth_date": "2023-12-25",
      "created_at": "2023-11-07T05:31:56Z",
      "loyalty_points": 123,
      "loyalty_points_expires_at": "2023-12-25",
      "cashback_balance": 123,
      "cashback_expires_at": "2023-12-25",
      "notifications_enabled": true
    }
  ],
  "pagination": {
    "current_page": 123,
    "total_pages": 123,
    "total_customers": 123
  }
}

Autorizações

X-API-KEY
string
header
obrigatório

Token específico do estabelecimento integrado. Disponível na seção de integrações do Portal do estabelecimento.

Parâmetros de consulta

page
number
padrão:1

Página desejada

Intervalo obrigatório: x >= 1
per_page
number
padrão:50

Quantidade de clientes por página

Intervalo obrigatório: 1 <= x <= 50

Resposta

Retorna um array com os clientes do estabelecimento.

Esse endpoint possui paginação, onde os parâmetros page e per page controlam a paginação, com um limite máximo de 50 registros por página.

customers
Cliente · object[]
obrigatório
pagination
object
obrigatório

Informações sobre a paginação

Última modificação em 27 de junho de 2026