Skip to main content

Listar clientes​

Listar clientes

Query Parameters
  • page any
  • limit any
  • search string

    Possible values: [name, email, document]

  • sortBy string

    Possible values: [name:ASC, name:DESC]

  • filter.type string

    Possible values: [$eq.INDIVIDUAL, $eq.COMPANY]

  • filter.document any
Responses
Schema
  • data Customer[] required
  • Array [
  • id string required

    Identificador do cliente

  • name string required

    Nome do cliente

  • email string

    E-mail do cliente

  • document string required

    Documento do cliente

  • type string required

    Possible values: [INDIVIDUAL, COMPANY]

    Tipo do cliente

  • clientId string required

    Identificador do cliente do marketplace

  • walletId string required

    Identificador da carteira do cliente

  • ]
  • meta object required
  • itemsPerPage number required

    Quantidade de itens por página

  • totalItems number required

    Total de itens

  • currentPage number required

    Página atual

  • totalPages number required

    Total de páginas

  • sortBy string[] required

    Ordenação por

  • links object required
  • current string required

    Link da página atual

Loading...