Skip to main content
Lista los contactos que tienen al menos uno de: identificador, email o teléfono. Orden y paginación configurables.

​
Autenticación

​
api_access_token
string
required
Token de usuario (userApiKey).

​
Parámetros de ruta

​
account_id
integer
required
ID de la cuenta.

​
Parámetros de consulta

​
sort
string
Orden: name, email, phone_number, last_activity_at; prefijo - para descendente. Ej: -last_activity_at.
​
page
integer
default:"1"
Número de página (tamaño fijo 15).

​
Ejemplo de solicitud

curl -X GET 'https://app.yampi.ai/api/v1/accounts/1/contacts?page=1&sort=-last_activity_at' \
  -H 'api_access_token: TU_TOKEN' \
  -H 'Content-Type: application/json'

​
Respuesta exitosa

{
  "payload": [
    {
      "id": 1,
      "name": "Alice",
      "email": "alice@acme.inc",
      "phone_number": "+123456789",
      "thumbnail": "https://...",
      "identifier": "ext-123",
      "last_activity_at": "2026-03-13T10:00:00Z",
      "custom_attributes": {}
    }
  ],
  "meta": { "count": 42 }
}
​
payload
array
Lista de contactos (objetos con id, name, email, phone_number, thumbnail, identifier, last_activity_at, custom_attributes).
​
meta.count
integer
Total de registros (para paginación).

​
Errores

  • 400: Bad Request — parámetros inválidos.
  • 401: No autenticado.