# List customers

Returns a list of customers.

Endpoint: GET /customers/list
Version: 1.0

## Query parameters:

  - `email` (string)

  - `documentNumber` (string)

  - `createdAt[startsAt]` (string)

  - `createdAt[endsAt]` (string)

  - `updatedAt[startsAt]` (string)

  - `updatedAt[endsAt]` (string)

  - `page` (string, required)
    Page number to access

  - `limit` (string, required)
    Number of items to be loaded per page

## Header parameters:

  - `x-api-key` (string, required)
    Api key provided on integrations tab in Easyflow platform.

  - `x-api-secret` (string, required)
    Api Secret provided on integrations tab in Easyflow platform.

  - `business-id` (string, required)
    Business Identifier

## Response 200 fields (application/json):

  - `statusCode` (integer)
    Example: 200

  - `data` (object)

  - `data.docs` (array)

  - `data.docs.id` (string)

  - `data.docs.createdAt` (string)

  - `data.docs.updatedAt` (string)

  - `data.docs.deletedAt` (string)

  - `data.docs.deleted` (boolean)

  - `data.docs.name` (string)

  - `data.docs.businessId` (string)

  - `data.docs.userId` (string)

  - `data.docs.email` (string)

  - `data.docs.phone` (object)

  - `data.docs.phone.areaCode` (string)

  - `data.docs.phone.ddd` (string)

  - `data.docs.phone.number` (string)

  - `data.docs.phone.isMobile` (boolean)

  - `data.docs.address` (object)

  - `data.docs.address.zipCode` (string)

  - `data.docs.address.street` (string)

  - `data.docs.address.number` (string)

  - `data.docs.address.complement` (string)

  - `data.docs.address.neighborhood` (string)

  - `data.docs.address.city` (string)

  - `data.docs.address.state` (string)
    The state must send an abbreviation (Example: sp)

  - `data.docs.deliveryAddress` (object)

  - `data.docs.deliveryAddress.zipCode` (string)

  - `data.docs.deliveryAddress.street` (string)

  - `data.docs.deliveryAddress.number` (string)

  - `data.docs.deliveryAddress.complement` (string)

  - `data.docs.deliveryAddress.neighborhood` (string)

  - `data.docs.deliveryAddress.city` (string)

  - `data.docs.deliveryAddress.state` (string)
    The state must send an abbreviation (Example: sp)

  - `data.docs.document` (object)

  - `data.docs.document.type` (string)
    Enum: "CPF", "CNPJ"

  - `data.docs.document.number` (string)

  - `data.limit` (integer)

  - `data.currentPage` (integer)

  - `data.hasNext` (boolean)

  - `data.nextPage` (integer)

  - `data.totalDocs` (integer)

  - `data.totalPages` (integer)

## Response 400 fields (application/json):

  - `message` (string)
    Invalid param: []
    Example: "Invalid param: []"

  - `error` (string)
    Bad Request
    Example: "Bad Request"

  - `statusCode` (integer)
    400
    Example: 400

## Response 401 fields (application/json):

  - `message` (string)
    Invalid field
    Example: "Unauthorized"

  - `error` (string)
    Unauthorized
    Example: "Unauthorized"

  - `statusCode` (integer)
    401
    Example: 401

## Response 403 fields (application/json):

  - `message` (string)
    Forbidden resource
    Example: "Forbidden resource"

  - `error` (string)
    Forbidden
    Example: "Forbidden"

  - `statusCode` (integer)
    403
    Example: 403

## Response 500 fields (application/json):

  - `message` (string)
    Internal server error
    Example: "Internal server error"

  - `error` (string)
    Internal Server Error
    Example: "Internal Server Error"

  - `statusCode` (integer)
    500
    Example: 500