Pular para o conteúdo
Contatos

Listar contatos

v1.0.0
GEThttps://api.growthaisystem.com/api/v1/contacts
  • ExigeAuthorization: Bearer gos_…— Chave de API (gos_…)· escoposcontacts.read

Paginação por cursor. Busca exata por email/phone (§9.4) e filtros de polling createdAfter/updatedAfter. Contato na Lixeira não sai — nem aqui, nem em nenhuma rota da API (o detalhe dele dá 404).

Parâmetros de consulta

Vão na querystring, depois do ?.

  • querystringopcional

    Busca textual: contatos cujo nome, e-mail ou telefone CONTÉM o termo, sem diferenciar maiúscula. No nome, ignora também o acento ("geor" acha "Geórgia" e "Georgia"). % e _ são texto, não curinga.

    • tamanho 1–200
  • emailstringopcional
    • tamanho 3–200
  • phonestringopcional
    • tamanho 3–40
  • tagstringopcional
    • tamanho 1–60
  • statusstringopcional
    • um de"active""archived"
  • createdAfterstringopcional
  • updatedAfterstringopcional
  • cursorstringopcional
  • limitintegeropcional
    • padrão 50
    • faixa 1–500

Respostas

6 respostas documentadas — o código, o que ele significa nesta rota e a forma do corpo.

200Deu certoapplication/json

Página de contatos do workspace, do mais novo para o mais antigo (createdAt DESC, desempate por id). data: [] também é sucesso — é "não há contato no recorte", nunca 404.

  • Cada item — V1Contact

    • idstring
    • namestring
    • phonestring | null
    • emailstring | null
    • companystring | null
    • companyIdstring | null
    • rolestring | null
    • cpfstring | null
    • notesstring | null
    • tagsstring[]
    • statusstring
      • um de"active""archived""merged"
    • ownerUserIdstring | null
    • originstring
    • customFieldsobjeto livre
      • chave string
      • valor qualquer valor JSON
    • createdAtstring
    • updatedAtstring
    • urlstring
      • sourcestring | null
      • mediumstring | null
      • campaignstring | null
      • termstring | null
      • contentstring | null
    • firstHumanTouchAtstring | nullpode faltar
    • lastHumanTouchAtstring | nullpode faltar
    • humanTouchCountintegerpode faltar

      Quantos toques humanos este contato recebeu (cada mensagem, ligação, e-mail ou nota com actor: "user" em /interactions conta um). 0 = nenhum. Mesma fonte de firstHumanTouchAt/lastHumanTouchAt; só vem em GET /contacts/{id}.

      • mín. 0
    • firstHumanTouchChannelstring | nullpode faltar

      O canal do PRIMEIRO toque humano — o mesmo registro de firstHumanTouchAt, no vocabulário de channel de /interactions (whatsapp, instagram, facebook, call, email, note…). Dois toques no mesmo instante: vale o de menor id de /interactions. null = nunca houve toque humano.

  • nextCursorstring | null

    Cursor opaco da PRÓXIMA página — passe em ?cursor=. null = acabou a lista.