Saltar al contenido principal
GET
Obtener simulaciones

Autorizaciones

x-api-key
string
header
requerido

API key que Pruff entrega a tu empresa.

Parámetros de consulta

startDate
string<date>

Fecha de creación desde la cual se buscan simulaciones (YYYY-MM-DD, día en hora de Chile).

endDate
string<date>

Fecha de creación hasta la cual se buscan simulaciones (YYYY-MM-DD, día en hora de Chile). Incluye el día completo. Debe ser igual o posterior a startDate.

businessIdentifier
string

RUT del cliente, sin puntos y con guion.

stakeholderIdentifier
string

RUT del deudor, sin puntos y con guion. Retorna las simulaciones que tengan al menos un documento de ese deudor.

executiveEmail
string<email>

Email del ejecutivo a cargo de la simulación. Si la simulación no tiene ejecutivo asignado, se considera a quien la creó.

status
enum<string>

Estado de la simulación: OPEN (abierta) o LOST (perdida). Sin este filtro se retornan ambos.

Opciones disponibles:
OPEN,
LOST
page
integer
predeterminado:1

Página que quieres obtener, desde 1.

Rango requerido: x >= 1
pageSize
integer
predeterminado:10

Cantidad de elementos por página. Máximo 500.

Rango requerido: 1 <= x <= 500

Respuesta

Página de simulaciones.

data
object[]
requerido
pagination
object
requerido