Saltar al contenido principal
GET
Obtener prospectos

Autorizaciones

x-api-key
string
header
requerido

API key que Pruff entrega a tu empresa.

Parámetros de consulta

period
enum<integer>
predeterminado:12

Meses hacia atrás sobre los que se calculan las cesiones. Valores posibles: 3, 6 o 12.

Opciones disponibles:
3,
6,
12
businessIdentifier
string

RUT del prospecto, sin puntos y con guion.

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 prospectos.

data
object[]
requerido
pagination
object
requerido