> ## Documentation Index > Fetch the complete documentation index at: https://docs.cardapioweb.com/llms.txt > Use this file to discover all available pages before exploring further. # Listar clientes > Retorna todos os clientes do estabelecimento. ## OpenAPI ````yaml /reference/api-loja.json get /api/partner/v1/merchant/customers openapi: 3.1.0 info: title: API Loja version: '1.0' description: >- A API de loja é responsável por fornecer informações referentes ao estabelecimento. O limite de requições desse endpoint é diferente dos demais, sendo limitado a 5 requisições por minuto. contact: email: integracao@cardapioweb.com url: https://cardapioweb.com name: Cardápio Web servers: - url: https://integracao.sandbox.cardapioweb.com description: Sandbox - description: Produção url: https://integracao.cardapioweb.com security: - apiKey: [] tags: - name: Avaliações - name: Clientes - name: Cupons - name: Loja paths: /api/partner/v1/merchant/customers: parameters: [] get: tags: - Clientes summary: Listar clientes description: Retorna todos os clientes do estabelecimento. operationId: index-merchant-customers parameters: - schema: type: number minimum: 1 default: 1 in: query name: page description: Página desejada - schema: type: number default: 50 minimum: 1 maximum: 50 in: query name: per_page description: Quantidade de clientes por página responses: '200': description: >- 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. content: application/json: schema: type: object x-examples: Example 1: coupons: - id: 5857 uid: 4ip code: TESTE name: Cupom Teste 3 type: percent_discount value: 15 active: true status: valid minimum_order_value: null use_limit: null new_customers_only: false customer_multi_use: true availability_start_time: null availability_end_time: null available_days: - sunday - monday - tuesday - wednesday - thursday - friday - saturday available_from: null expires_at: null - id: 5870 uid: 4j2 code: null name: Teste type: percent_discount value: 10.5 active: true status: valid minimum_order_value: null use_limit: null new_customers_only: false customer_multi_use: true availability_start_time: null availability_end_time: null available_days: [] available_from: null expires_at: null pagination: current_page: 1 total_pages: 4 total_coupons: 8 required: - customers - pagination properties: customers: type: array items: $ref: '#/components/schemas/Customer' x-stoplight: id: sz7yl4tg9tgop pagination: type: object description: Informações sobre a paginação required: - current_page - total_pages - total_customers properties: current_page: type: integer description: Página atual total_pages: type: integer description: Total de páginas total_customers: type: integer description: Total de cupons x-stoplight: id: odpjsk6q2w8x8 '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '429': $ref: '#/components/responses/TooManyRequests' components: schemas: Customer: type: object title: Cliente description: Estrutura do cliente examples: - id: 123456 name: José da Silva phone_number: '11999999999' email: email@teste.com birth_date: '1980-08-24' created_at: '2023-05-10T17:43:40.521-03:00' loyalty_points: 150 notifications_enabled: true properties: id: type: integer description: Identificador único do cliente name: type: string description: Nome do cliente email: type: - string - 'null' description: E-mail format: email phone_number: type: - string - 'null' description: Número de telefone ddi: type: - string - 'null' x-stoplight: id: gtczx6jf59wrt description: Código do país do número de telefone birth_date: type: - string - 'null' description: Data de nascimento format: date gender: x-stoplight: id: ozwau174a0gkg enum: - female - male - non-binary - other description: Gênero created_at: type: string description: Data de criação format: date-time loyalty_points: type: integer description: Total de pontos de fidelidade loyalty_points_expires_at: type: - string - 'null' x-stoplight: id: 3eewlh69xubpt format: date description: Data de expiração do saldo de pontos de fidelidade cashback_balance: type: number x-stoplight: id: qzqfjgw9736sj description: Saldo de cashback cashback_expires_at: type: - string - 'null' x-stoplight: id: 8rpiq5mihf0ch format: date description: Data de expiração do saldo de cashback notifications_enabled: type: boolean description: >- Indica se o envio de mensagens via WhatsApp para o cliente está liberado default: true BadRequest: type: object examples: - code: 4000 message: Parâmetros inválidos details: updated_since não é uma data válida - code: 4000 message: Parâmetros inválidos details: status contém valores inválidos properties: code: type: integer description: Código interno de identificação do erro message: type: string description: Mensagem de resumo do erro details: type: string description: Informações adicionais sobre o erro required: - code - message title: BadRequest x-internal: false Unauthorized: type: object x-stoplight: id: 43a37f11m9auy examples: - code: 4010 message: Token inválido title: Unauthorized x-internal: false properties: code: type: integer description: Código interno de identificação do erro message: type: string description: Mensagem de resumo do erro required: - code - message responses: BadRequest: description: Algum parâmetro enviado é inválido. content: application/json: schema: $ref: '#/components/schemas/BadRequest' Unauthorized: description: >- Não autorizado. Não foi enviado o token no header "X-API-KEY" ou ele é inválido. content: application/json: schema: $ref: '#/components/schemas/Unauthorized' TooManyRequests: description: >- Muitas requisições foram feitas em um curto período. Verifique nossas regras de rate limit. content: {} securitySchemes: apiKey: name: X-API-KEY type: apiKey in: header description: >- Token específico do estabelecimento integrado. Disponível na seção de integrações do Portal do estabelecimento. ````