---
title: "Listar clientes"
url: "https://devcenter.stone.com.br/apis/v5-docs-legacy/versions/b9aaff36-6dcc-4353-8398-836d6c13dfa5/operations/listar-clientes-1"
---

> Full API specification: https://devcenter.stone.com.br/apis/v5-docs-legacy/versions/b9aaff36-6dcc-4353-8398-836d6c13dfa5.md

# Listar clientes

`GET` `/customers`

Operation ID: `listar-clientes-1`

Este recurso permite a obtenção da **carteira de clientes** do lojista. Pode ser utilizados alguns parâmetros como filtro da listagem

## Query parameters

- `name` (string, optional) - Nome do cliente
- `document` (string, optional) - CPF ou CNPJ do cliente. Max: 16 caracteres
- `email` (string, optional) - E-mail do cliente
- `gender` (string, optional) - Sexo do cliente . Valores possíveis: **male** ou **female**
- `page` (integer, int32, optional) - Página atual.
- `size` (integer, int32, optional) - Quantidade de itens por página.
- `code` (string, optional) - Código do cliente no sistema do lojista

## Responses

- `200` - 200
- `401` - 401

## OpenAPI definition

```yaml
openapi: 3.1.0
info:
  title: Pagar.me v5 API (Legado)
  version: 5.0.0
servers:
  - url: https://api.stone.com.br/core/v5
paths:
  /customers:
    get:
      summary: Listar clientes
      description: Este recurso permite a obtenção da **carteira de clientes** do
        lojista. Pode ser utilizados alguns parâmetros como filtro da listagem
      operationId: listar-clientes-1
      parameters:
        - name: name
          in: query
          description: Nome do cliente
          schema:
            type: string
        - name: document
          in: query
          description: "CPF ou CNPJ do cliente. Max: 16 caracteres"
          schema:
            type: string
        - name: email
          in: query
          description: E-mail do cliente
          schema:
            type: string
        - name: gender
          in: query
          description: "Sexo do cliente . Valores possíveis: **male** ou **female**"
          schema:
            type: string
        - name: page
          in: query
          description: Página atual.
          schema:
            type: integer
            format: int32
            default: 1
        - name: size
          in: query
          description: Quantidade de itens por página.
          schema:
            type: integer
            format: int32
            default: 10
        - name: code
          in: query
          description: Código do cliente no sistema do lojista
          schema:
            type: string
            default: "10"
      responses:
        "200":
          description: "200"
          content:
            application/json:
              examples:
                Result:
                  value: >-
                    {
                      "data": [
                        {
                          "id": "cus_n2Y17zAt67s2Oplg",
                          "name": "Monitor",
                          "gender": "male",
                          "email": "9bfdfb6b-405f-489e-a4e0-b66101c86743@pagar.me",
                          "delinquent": false,
                          "created_at": "2017-04-19T17:43:10Z",
                          "updated_at": "2017-04-19T17:43:10Z"
                        },
                        {
                          "id": "cus_Z7DvZNpUZhYlvndR",
                          "name": "Monitor",
                          "gender": "female",
                          "email": "c17b44be-85a8-4a1c-a9d1-5e0109cb4ece@pagar.me",
                          "delinquent": false,
                          "created_at": "2017-04-19T17:42:51Z",
                          "updated_at": "2017-04-19T17:42:51Z"
                        }
                      ],
                      "paging": {
                        "total": 545797,
                        "next": "https://api.stone.com.br:4443/core/v1/customers?page=2&size=10"
                      }
                    }
        "401":
          description: "401"
          content:
            application/json:
              examples:
                Result:
                  value: >-
                    {
                        "message": "Authorization has been denied for this request."
                    }
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Authorization has been denied for this request.
      deprecated: false
security:
  - sec0: []
components:
  securitySchemes:
    sec0:
      type: http
      scheme: basic
```