Growth OS API
Referência da APIContatos

Listar contatos

Paginação por cursor. Busca exata por `email`/`phone` (§9.4) e filtros de polling `createdAfter`/`updatedAfter`.

GET
/contacts

Paginação por cursor. Busca exata por email/phone (§9.4) e filtros de polling createdAfter/updatedAfter.

Autorização

apiKey
AutorizaçãoBearer <token>

Chave de API (gos_…)

Em: header

Parâmetros de consulta

query?string
Length1 <= length <= 200
email?string
Length3 <= length <= 200
phone?string
Length3 <= length <= 40
tag?string
Length1 <= length <= 60
status?string

Value in

  • "active"
  • "archived"
createdAfter?string
updatedAfter?string
cursor?string
limit?integer
Range1 <= value <= 500
Default50

Corpo da resposta

application/json

curl -X GET "https://example.com/contacts"
{  "data": [    {      "id": "string",      "name": "string",      "phone": "string",      "email": "string",      "company": "string",      "companyId": "string",      "role": "string",      "cpf": "string",      "notes": "string",      "tags": [        "string"      ],      "status": "active",      "ownerUserId": "string",      "origin": "string",      "customFields": {        "property1": null,        "property2": null      },      "createdAt": "string",      "updatedAt": "string",      "url": "string",      "utm": {        "source": "string",        "medium": "string",        "campaign": "string",        "term": "string",        "content": "string"      },      "firstHumanTouchAt": "string",      "lastHumanTouchAt": "string"    }  ],  "nextCursor": "string"}

Criar ou atualizar contato (upsert)

Dedup telefone-primeiro/e-mail-depois (§9.4). Achou: atualiza preenchendo (nome só preenche vazio; tags são adicionadas; nada é apagado). Não achou: cria.

Listar membros do workspace

Inclui membros desativados (`active: false`) para resolver nomes de responsáveis antigos. `role` é o preset (owner|operador|atendente|visualizador) ou o nome do papel custom (ex.: "SDR", "Closer").