Lista de contactos

GET https://app.sendapp.ai/api/contacts

Recupera a lista paginada dos seus contactos, com filtros de pesquisa e etiqueta. Útil também para encontrar os IDs a usar ao eliminar. A autenticação pode passar pelo header X-API-Key ou pelo campo apikey.

Parâmetros

7 · 1 obrigatórios

apikey obrigatório

A sua API Key (o cabeçalho X-API-Key também funciona).

page opcional

Número de página (padrão 1).

per_page opcional

Itens por página (padrão 100, máx. 1000).

search opcional

Pesquisar por nome, telefone ou email (LIKE).

tag opcional

Correspondência exata de etiqueta.

with_phone opcional

Apenas contactos com um número de telefone.

with_email opcional

Apenas contactos com um email.

Precisa de ajuda com a integração? info@sendapp.live

Pedido

curl 'https://app.sendapp.ai/api/contacts?page=1&per_page=50&search=mario' \
  -H 'X-API-Key: YOUR_API_KEY'

<?php
$ch = curl_init('https://app.sendapp.ai/api/contacts?page=1&per_page=50&search=mario');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ['X-API-Key: YOUR_API_KEY'],
]);
echo curl_exec($ch);
curl_close($ch);

const params = new URLSearchParams({ page: 1, per_page: 50, search: 'mario' });
const res = await fetch('https://app.sendapp.ai/api/contacts?' + params, {
  headers: { 'X-API-Key': 'YOUR_API_KEY' }
});
console.log(await res.json());

Resposta

{
  "status": "success",
  "pagination": {
    "total": 128,
    "per_page": 50,
    "current_page": 1,
    "last_page": 3
  },
  "contacts": [
    {
      "id": 4021,
      "name": "Mario Rossi",
      "phone": "391234567890",
      "email": "mario.rossi@example.com",
      "tags": [
        "vip",
        "newsletter"
      ],
      "metadata": {
        "import_source": "csv"
      },
      "created_at": "2026-07-13 10:00:00",
      "updated_at": "2026-07-13 10:00:00"
    }
  ]
}

{
  "status": "error",
  "message": "Invalid API key."
}