Saltar al contenido principal
GET
Listar empresas

Autorizaciones

x-api-key
string
header
requerido

API key que Pruff entrega a tu empresa.

Parámetros de consulta

businessIdentifier
string

RUT de la empresa, sin puntos y con guion.

executiveEmail
string<email>

Email de un ejecutivo. Retorna las empresas asignadas a ese ejecutivo en la cartera. Si el email no corresponde a ningún usuario, la lista viene vacía.

tag
string

Nombre exacto de un tag de la empresa.

Minimum string length: 1
isEnrolled
enum<string>

true retorna solo las empresas enroladas y false solo las que no lo están. El campo isEnrolled de la respuesta explica qué cuenta como enrolada.

Opciones disponibles:
true,
false
relation
enum<string>

client retorna solo los clientes y prospect solo las empresas del pipeline comercial. El campo relation de la respuesta explica cada valor.

Opciones disponibles:
client,
prospect
page
integer
predeterminado:1

Página que quieres obtener, desde 1. Máximo 100000.

Rango requerido: 1 <= x <= 100000
pageSize
integer
predeterminado:10

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

Rango requerido: 1 <= x <= 500

Respuesta

Página de empresas.

data
object[]
requerido
pagination
object
requerido