Saltar al contenido principal
GET
Obtener un registro 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"

recordId
string
requerido

Identificador único del registro de pipeline.

Required string length: 1 - 255
Ejemplo:

"0d3c7f0e-5a43-5c0e-9f53-1f6a4b2e7d11"

Respuesta

Respuesta satisfactoria

Un registro de un pipeline, como una oportunidad de venta de un contacto.

id
string
requerido

Identificador único del registro.

Ejemplo:

"0d3c7f0e-5a43-5c0e-9f53-1f6a4b2e7d11"

pipelineId
string
requerido

Pipeline al que pertenece el registro.

Ejemplo:

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

pipelineVersion
integer
requerido

Versión del pipeline que sigue el registro.

Ejemplo:

3

stageId
string
requerido

Etapa en la que está el registro.

Ejemplo:

"stage-new"

state
enum<string>
requerido

OPEN mientras el registro está en una etapa abierta, FINAL cuando está en una etapa final.

Opciones disponibles:
OPEN,
FINAL
Ejemplo:

"OPEN"

name
string
requerido

Nombre del registro.

Ejemplo:

"Acme renewal 2027"

contact
Contact · object
requerido

El contacto al que pertenece el registro.

source
enum<string>
requerido

Cómo se creó el registro: API, ADVISOR, INBOUND_SESSION o FROM_PIPELINE.

Opciones disponibles:
ADVISOR,
API,
INBOUND_SESSION,
FROM_PIPELINE
Ejemplo:

"API"

revision
integer
requerido

Aumenta en uno cada vez que el registro cambia.

Ejemplo:

1

createdAt
string
requerido

Cuándo se creó el registro.

Ejemplo:

"2026-11-11T15:00:00.000Z"

updatedAt
string
requerido

Cuándo cambió el registro por última vez.

Ejemplo:

"2026-11-11T15:00:00.000Z"

values
Values · object

Valores de los atributos del registro, indexados por id de atributo.

Ejemplo:
ownerId
string | null

Id del Usuario de Bridge propietario del registro. Resuélvelo con GET /users/{userId}.

Ejemplo:

null

externalId
string | null

El id del registro en tu sistema, cuando se creó con uno.

Ejemplo:

"ERP-OPP-981"

closeReason
RecordCloseReasonResponse · object | null

El motivo con el que se cerró un registro cerrado.

closedAt
string | null

Cuándo el registro llegó a una etapa final; null mientras está abierto.

Ejemplo:

null