Pular para o conteúdo principal
GET
Listar contatos

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

ownerEmail
string | null

Filtra contatos pelo e-mail do proprietário. Obsoleto: será removido. Não há substituto; filtre por ownerId no seu próprio código. Consulte o histórico de alterações. Filtrar contatos pelo e-mail do proprietário

search
string | null

Busca contatos por nome, e-mail ou celular. Obsoleto: será removido. Para encontrar um contato por celular ou e-mail, use GET /contacts/lookup. Consulte o histórico de alterações. Buscar contatos por nome, e-mail ou celular

Exemplo:

"John Doe"

limit
integer
padrão:20

Número de contatos por página

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

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

Resposta

Resposta bem-sucedida

Corpo da resposta para listar contatos.

contacts
ContactResponse · object[]
obrigatório

Lista de contatos.

cursor
string | null

Cursor a ser enviado ao solicitar a próxima página.