Saltar al contenido principal
GET
Listar contactos

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

ownerEmail
string | null

Filtra contactos por el correo electrónico del propietario. Obsoleto: se eliminará. No tiene reemplazo; filtra por ownerId en tu propio código. Consulta el historial de cambios. Filtrar contactos por el correo electrónico del propietario

search
string | null

Busca contactos por nombre, correo electrónico o celular. Obsoleto: se eliminará. Para encontrar un contacto por celular o correo electrónico, usa GET /contacts/lookup. Consulta el historial de cambios. Buscar contactos por nombre, correo electrónico o celular

Ejemplo:

"John Doe"

limit
integer
predeterminado:20

Número de contactos por página

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

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

Respuesta

Respuesta satisfactoria

Cuerpo de respuesta para listar contactos.

contacts
ContactResponse · object[]
requerido

Lista de contactos.

cursor
string | null

Cursor que se enviará al solicitar la página siguiente.