Skip to main content
GET
Detalhes de um contato

Authorizations

Authorization
string
header
required

API Key da organização (Authorization: Bearer ik_live_xxx)

Path Parameters

id
string
required

ID do contato (UUID)

Response

O contato

id
string
required
name
string | null
required
email
string | null
required
phone
string | null
required

E.164 (nulo no contato só do Instagram ou do Messenger)

company
object | null
required
source
enum<string>
required

De onde veio: manual, import, api, assistant, call, whatsapp, instagram, messenger ou campaign

Available options:
manual,
import,
api,
assistant,
call,
whatsapp,
instagram,
messenger,
campaign
tags
string[]
required
custom_fields
object
required

Base legal (LGPD)

Available options:
consent,
legitimate_interest,
contract,
legal_obligation
opt_out
boolean
required

Não quer ser contatado (a campanha pula)

opt_out_at
string | null
required

Desde quando

Example:

"2026-11-02T14:00:00.000Z"

last_interaction_at
string | null
required

Última ligação ou conversa

Example:

"2026-11-02T14:00:00.000Z"

created_at
string
required

Criação (UTC)

Example:

"2026-11-02T14:00:00.000Z"

updated_at
string
required

Última mudança (UTC)

Example:

"2026-11-02T14:00:00.000Z"