Resgata icon

Resgata

Integracao completa com a API Resgata para gestao de credito consignado

Cliente → Listar Clientes

AI-generated

Summary

List customers from the Resgata API with optional filtering, pagination, and limit controls.

Inputs

  • Pagina — Page number to retrieve (default is 1).
  • Limite — Maximum number of customer results to return per page (minimum 1, default 50).
  • Filtros — Collection of optional filters to refine customer results, including search by name, CPF, email, or phone; status (active, inactive, blocked, pending); minimum and maximum score (0-1000); employment link presence; verification status; state; city; creation date range (after and before).

Output shape

A list of customer records matching the specified filters and pagination.

Results are returned as an array of customer objects. Pagination information may be included when available. If no customers match, the response includes an empty data array or empty result set. Errors are returned with standard error fields if operation fails.

Discussion