Listar Contatos

GET /external/v1/contacts

Retorna uma lista paginada de todos os contatos na sua conta.

Autenticacao

Requer permissao contacts:read.

Parametros de Query

Parametro	Tipo	Padrao	Descricao
page	integer	1	Numero da pagina para paginacao
limit	integer	20	Itens por pagina (1-100)
search	string	-	Buscar por nome, e-mail ou empresa
company	string	-	Filtrar por nome da empresa
email	string	-	Filtrar por endereco de e-mail
source	string	-	Filtrar por origem (linkedin, google_maps, list)
tags	string	-	Filtrar por tags (separadas por virgula)
sort_by	string	created_at	Campo de ordenacao
sort_order	string	desc	Ordem (asc, desc)

Requisicao

cURL

curl --request GET \
  --url "https://app.getraze.com/external/v1/contacts?page=1&limit=20" \
  --header "X-API-Key: YOUR_API_KEY"

Node.js

const axios = require('axios');

const response = await axios.get('https://app.getraze.com/external/v1/contacts', {
  headers: {
    'X-API-Key': 'YOUR_API_KEY'
  },
  params: {
    page: 1,
    limit: 20,
    search: 'john'
  }
});

console.log(response.data);

Python

import requests

response = requests.get(
    'https://app.getraze.com/external/v1/contacts',
    headers={'X-API-Key': 'YOUR_API_KEY'},
    params={'page': 1, 'limit': 20}
)

print(response.json())

Resposta

{
  "success": true,
  "data": {
    "contacts": [
      {
        "id": "cnt_abc123def456",
        "name": "John Doe",
        "email": "john@example.com",
        "phone": "+5511999999999",
        "company": "Acme Inc",
        "position": "CEO",
        "source": "linkedin",
        "linkedin_url": "https://linkedin.com/in/johndoe",
        "tags": ["prospect", "decision-maker"],
        "custom_fields": {},
        "created_at": "2024-01-15T10:30:00Z",
        "updated_at": "2024-01-20T14:00:00Z"
      }
    ],
    "pagination": {
      "page": 1,
      "limit": 20,
      "total": 150,
      "total_pages": 8
    }
  }
}

Campos da Resposta

Campo	Tipo	Descricao
contacts	array	Lista de objetos de contato
pagination.page	integer	Numero da pagina atual
pagination.limit	integer	Itens por pagina
pagination.total	integer	Numero total de contatos
pagination.total_pages	integer	Numero total de paginas