Contacts
Listar contactos
Obtener todos los contactos de tu organización con paginación y búsqueda.
GET
/
api
/
contacts
curl -X GET "https://app.horneross.com/api/contacts?limit=50&search=gmail" \
-H "Authorization: Bearer sk_live_xxx"
const response = await fetch(
'https://app.horneross.com/api/contacts?limit=50&search=gmail',
{
headers: {
'Authorization': 'Bearer sk_live_xxx',
},
}
);
const { contacts, count } = await response.json();
console.log(`Total: ${count} contactos`);
import requests
response = requests.get(
'https://app.horneross.com/api/contacts',
headers={'Authorization': 'Bearer sk_live_xxx'},
params={
'limit': 50,
'search': 'gmail'
}
)
data = response.json()
print(f'Total: {data["count"]} contactos')
{
"contacts": [
{
"id": "contact_abc123",
"email": "maria@gmail.com",
"phoneNumber": "+5491123456789",
"firstName": "María",
"lastName": "García",
"instagramId": null,
"organizationId": "org_xyz",
"createdAt": "2024-01-21T10:00:00Z",
"updatedAt": "2024-01-21T15:30:00Z"
},
{
"id": "contact_def456",
"email": "juan@gmail.com",
"phoneNumber": null,
"firstName": "Juan",
"lastName": "Pérez",
"instagramId": null,
"organizationId": "org_xyz",
"createdAt": "2024-01-20T14:00:00Z",
"updatedAt": "2024-01-20T14:00:00Z"
}
],
"count": 150
}
Endpoint
GET /api/contacts
Headers
string
required
Bearer token con tu API key. Formato:
Bearer sk_live_xxxQuery Parameters
number
default:"0"
Número de página para paginación (0-indexed)
number
default:"100"
Cantidad de resultados por página
string
Buscar contactos por email (búsqueda parcial)
curl -X GET "https://app.horneross.com/api/contacts?limit=50&search=gmail" \
-H "Authorization: Bearer sk_live_xxx"
const response = await fetch(
'https://app.horneross.com/api/contacts?limit=50&search=gmail',
{
headers: {
'Authorization': 'Bearer sk_live_xxx',
},
}
);
const { contacts, count } = await response.json();
console.log(`Total: ${count} contactos`);
import requests
response = requests.get(
'https://app.horneross.com/api/contacts',
headers={'Authorization': 'Bearer sk_live_xxx'},
params={
'limit': 50,
'search': 'gmail'
}
)
data = response.json()
print(f'Total: {data["count"]} contactos')
Response
array
required
Array de contactos
Show Propiedades de cada contacto
Show Propiedades de cada contacto
string
required
ID único del contacto
string
Email del contacto
string
Número de teléfono (con código de país)
string
Nombre del contacto
string
Apellido del contacto
string
ID de Instagram (si fue capturado via Instagram)
string
required
ID de la organización
string
required
Fecha de creación (ISO 8601)
string
required
Fecha de última actualización (ISO 8601)
number
required
Total de contactos que coinciden con los filtros (para paginación)
{
"contacts": [
{
"id": "contact_abc123",
"email": "maria@gmail.com",
"phoneNumber": "+5491123456789",
"firstName": "María",
"lastName": "García",
"instagramId": null,
"organizationId": "org_xyz",
"createdAt": "2024-01-21T10:00:00Z",
"updatedAt": "2024-01-21T15:30:00Z"
},
{
"id": "contact_def456",
"email": "juan@gmail.com",
"phoneNumber": null,
"firstName": "Juan",
"lastName": "Pérez",
"instagramId": null,
"organizationId": "org_xyz",
"createdAt": "2024-01-20T14:00:00Z",
"updatedAt": "2024-01-20T14:00:00Z"
}
],
"count": 150
}
Paginación
Para paginar resultados, usáoffset y limit:
// Primera página
const page1 = await fetch('/api/contacts?offset=0&limit=50');
// Segunda página
const page2 = await fetch('/api/contacts?offset=1&limit=50');
// Tercera página
const page3 = await fetch('/api/contacts?offset=2&limit=50');
El
offset representa el número de página (0-indexed), no el número de registros a saltar.Was this page helpful?
⌘I
curl -X GET "https://app.horneross.com/api/contacts?limit=50&search=gmail" \
-H "Authorization: Bearer sk_live_xxx"
const response = await fetch(
'https://app.horneross.com/api/contacts?limit=50&search=gmail',
{
headers: {
'Authorization': 'Bearer sk_live_xxx',
},
}
);
const { contacts, count } = await response.json();
console.log(`Total: ${count} contactos`);
import requests
response = requests.get(
'https://app.horneross.com/api/contacts',
headers={'Authorization': 'Bearer sk_live_xxx'},
params={
'limit': 50,
'search': 'gmail'
}
)
data = response.json()
print(f'Total: {data["count"]} contactos')
{
"contacts": [
{
"id": "contact_abc123",
"email": "maria@gmail.com",
"phoneNumber": "+5491123456789",
"firstName": "María",
"lastName": "García",
"instagramId": null,
"organizationId": "org_xyz",
"createdAt": "2024-01-21T10:00:00Z",
"updatedAt": "2024-01-21T15:30:00Z"
},
{
"id": "contact_def456",
"email": "juan@gmail.com",
"phoneNumber": null,
"firstName": "Juan",
"lastName": "Pérez",
"instagramId": null,
"organizationId": "org_xyz",
"createdAt": "2024-01-20T14:00:00Z",
"updatedAt": "2024-01-20T14:00:00Z"
}
],
"count": 150
}