Pular para o conteúdo principal
GET
Listar registros de pipeline

Autorizações

x-api-key
string
header
obrigatório

Copy the API key as provided by the Bridge Console.

Parâmetros de caminho

workspaceId
string<uuid>
obrigatório

Identificador único do workspace (UUID v4).

Exemplo:

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

Parâmetros de consulta

externalId
string | null

Id do registro no seu sistema.

Required string length: 1 - 255
Exemplo:

"ERP-OPP-981"

contactId
string<uuid> | null

Id do contato cujos registros serão listados.

Exemplo:

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

contactPhone
string | null

Celular do contato cujos registros serão listados, interpretado como o GET /contacts/lookup o interpreta.

Required string length: 1 - 320
Exemplo:

"+573001234567"

contactEmail
string | null

E-mail do contato cujos registros serão listados, interpretado como o GET /contacts/lookup o interpreta.

Required string length: 1 - 320
Exemplo:

"john.doe@example.com"

pipelineId
string | null

Pipeline dos registros.

Required string length: 1 - 255
Exemplo:

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

stageId
string | null

Etapa dos registros; requer pipelineId.

Required string length: 1 - 255
Exemplo:

"stage-new"

limit
integer
padrão:25

Número de registros por página.

Intervalo obrigatório: 1 <= x <= 100
cursor
string | null

Cursor recebido em uma solicitação anterior para obter a próxima página.

Resposta

Resposta bem-sucedida

Corpo da resposta para listar registros de pipeline.

records
PipelineRecordResponse · object[]
obrigatório

Registros da página, do atualizado mais recentemente ao mais antigo.

cursor
string | null

Envie-o como cursor para obter a próxima página; null na última página.