Skip to main content
GET
Exportar contatos
Exporta os contatos do seu workspace, paginados por cursor.
  • Carga completa (pontual): chame sem updated_since para trazer todos os contatos.
  • Incremental: informe updated_since (ISO 8601) para trazer apenas o que mudou desde então.
Pagine passando o next_cursor da resposta como cursor na chamada seguinte, até ele voltar null. Grave as linhas com upsert por id — a mesma linha pode reaparecer entre pulls (semântica CDC). O significado de cada campo retornado está detalhado na seção Response abaixo.
phone_number é o telefone do seu contato (E.164). É liberado porque o dado é do seu workspace, mas é PII — trate-o com o mesmo cuidado ao gravar e compartilhar.

Authorizations

Authorization
string
header
required

Workspace API key no formato mk_..., gerada na plataforma em Integrações → Configurar API.

Query Parameters

updated_since
string<date-time>

Timestamp ISO 8601. Marca-d'água incremental: retorna apenas o que mudou desde então. Omita para uma exportação completa.

cursor
string

Cursor opaco de paginação, conforme retornado em next_cursor na página anterior.

limit
integer
default:100

Máximo de linhas por página (1 a 1000, padrão 100). Valores fora do intervalo são ajustados, não rejeitados.

Required range: 1 <= x <= 1000

Response

Página de dados.

data
object[]
required

Linhas desta página.

next_cursor
string | null
required

Cursor da próxima página; null quando não há mais páginas.

count
integer
required

Número de linhas nesta página.