A Contacts Activity API fornece um feed ordenado por tempo de cada alteração nos seus contatos — criações, mudanças de função, exclusões permanentes e fusões. Ao contrário de uma lista de contatos padrão, ela captura alterações que seriam invisíveis, facilitando manter ferramentas externas como CRMs, data warehouses e plataformas de marketing sincronizadas.
Importante: Este endpoint requer a versão Preview da API e um token com o escopo `read_users_companies`. Inclua o cabeçalho `Intercom-Version: Preview` em todas as requisições.
Eventos de contato rastreados pela API
O feed registra os seguintes eventos do ciclo de vida do contato:
Contato criado
Função do contato alterada
Contato excluído permanentemente
Contatos mesclados
Isto é especialmente útil se você sincroniza dados de contato com ferramentas externas — CRMs, data warehouses ou plataformas de marketing — porque captura exclusões e fusões que uma lista de contatos padrão não refletirá.
Como fazer sua primeira requisição API
A API é acessada diretamente via HTTP — não existe uma interface no produto. Para começar:
Autentique-se com um token de acesso que possua o escopo `read_users_companies`.
Envie uma requisição GET para `/contacts/activities`.
Navegue pelos resultados usando o parâmetro de cursor `starting_after`.
Controle o tamanho da página com `per_page` (padrão: 50, máximo: 150).
Limitações
Considere as seguintes restrições ao construir sua integração:
Dados retornados | O feed retorna apenas IDs, funções e timestamps — sem endereços de e-mail, nomes ou outros atributos de contato. |
Retenção | Os eventos são retidos por 90 dias via time-to-live (TTL). Eventos com mais de 90 dias não estão disponíveis. |
Sem backfill | Apenas contatos criados ou atualizados após 6 de agosto de 2026 estão incluídos. Não há backfill do histórico de contatos anterior. |
Entrega pelo menos uma vez | O mesmo evento pode aparecer mais de uma vez com cursors diferentes. Faça deduplicação por ID do contato e tipo de evento na sua aplicação ou integração. |
Gravações com esforço máximo | Ocasionalmente, um evento pode ser perdido se ocorrer uma falha de gravação. Isso nunca afeta a ação do contato originador em si. |
Apenas exclusões | contact.deleted cobre apenas exclusão permanente — contatos arquivados não aparecem como excluídos. |
Apenas paginação por cursor | Use pages.next para verificar se existem mais eventos e passe-o como starting_after para recuperar a próxima página. Paginação por offset não é suportada. |
Nota: A Contacts Activity API está disponível no plano Contact Activities nas regiões de dados US, EU e AU. Ela não faz parte de workspaces Fin Standalone.