Saltar al contenido principal
GET
Listar registros de pipeline

Autorizaciones

x-api-key
string
header
requerido

Copy the API key as provided by the Bridge Console.

Parámetros de ruta

workspaceId
string<uuid>
requerido

Identificador único del workspace (UUID v4).

Ejemplo:

"b6cf1c4a-2b1e-4e63-8f3e-0f9d1a2a1234"

Parámetros de consulta

externalId
string | null

Id del registro en tu sistema.

Required string length: 1 - 255
Ejemplo:

"ERP-OPP-981"

contactId
string<uuid> | null

Id del contacto cuyos registros se listan.

Ejemplo:

"4e362e2b-67b2-4a7e-a9df-e9ecf9141be8"

contactPhone
string | null

Celular del contacto cuyos registros se listan, interpretado como lo hace GET /contacts/lookup.

Required string length: 1 - 320
Ejemplo:

"+573001234567"

contactEmail
string | null

Correo electrónico del contacto cuyos registros se listan, interpretado como lo hace GET /contacts/lookup.

Required string length: 1 - 320
Ejemplo:

"john.doe@example.com"

pipelineId
string | null

Pipeline de los registros.

Required string length: 1 - 255
Ejemplo:

"5d0b8f8e-3c1a-4a4e-9a57-2f6f3e1c9b10"

stageId
string | null

Etapa de los registros; requiere pipelineId.

Required string length: 1 - 255
Ejemplo:

"stage-new"

limit
integer
predeterminado:25

Número de registros por página.

Rango requerido: 1 <= x <= 100
cursor
string | null

Cursor recibido en una solicitud anterior para obtener la página siguiente.

Respuesta

Respuesta satisfactoria

Cuerpo de respuesta para listar registros de pipeline.

records
PipelineRecordResponse · object[]
requerido

Registros de la página, del actualizado más recientemente al más antiguo.

cursor
string | null

Envíalo como cursor para obtener la página siguiente; null en la última página.