ResgataInstall

Summary

List proposals in the Resgata system applying optional filters, pagination, and sorting to refine the results.

Inputs

• Pagina — Page number of the results to retrieve, default is 1.
• Limite — Maximum number of proposals to return per page, minimum 1, default is 50.
• Filtros — Collection of filters to narrow down proposals by various criteria including CPF, protocol number, phone, status, loan type, value range, date range, bank code, channel, user ID, search text (name, CPF, or protocol), sorting field, and sort order.

Output shape

a list of proposal objects matching the specified filters and pagination parameters. A pagination object is included if available.

Results include an array of proposals in the output. If pagination metadata is returned by the API, it will be included in the output as an object with _pagination key. The operation supports filtering by multiple criteria and sorting by fields such as creation date, update date, requested amount, status, and risk score in ascending or descending order.

Examples

Example 1: List the first 50 proposals with status 'draft' sorted by creation date descending.

Set 'Pagina' to 1, 'Limite' to 50, and in 'Filtros', set 'Status' to 'draft', 'Ordenar Por' to 'createdAt', and 'Ordem' to 'desc'.

Example 2: Retrieve page 2 of proposals filtered by CPF and loan type with a minimum value of 1000.

Set 'Pagina' to 2, and in 'Filtros', specify 'CPF', 'Tipo De Emprestimo' as needed, and 'Valor Minimo' to 1000.