v1

latestOpenAPI 3.0.32026-07-24398641.3 MB

Contacts

contacts__getContacts

Lista los contactos (clientes y/o proveedores) de la cuenta con filtros y paginación. Equivale a GET /contacts de la API de Alegra. El parámetro mode=advanced retorna objetos completos; mode=simple retorna un subconjunto reducido. Para búsquedas por texto libre usar query; para encontrar exactamente por documento, identification.

post/tools/contacts__getContacts

Request body

limitinteger

Cantidad máxima de contactos a retornar. El servidor MCP fuerza un tope de 30.

startinteger

Offset para paginación (número de contactos a omitir desde el inicio).

order_direction'ASC' | 'DESC'

Dirección del ordenamiento.

order_fieldstring

Campo por el cual ordenar (p. ej. name, id, identification).

querystring

Texto libre. Busca coincidencias en nombre, identificación, email, etc.

identificationstring

Filtra por número de identificación exacto (NIT, cédula, RFC, según país).

namestring

Filtra por nombre del contacto.

type'client' | 'provider'

Filtra por tipo de contacto. Si se omite, retorna ambos.

mode'advanced' | 'simple'

Modo de respuesta: simple retorna un subconjunto de campos; advanced retorna el contacto completo.

Example request

{
  "limit": 30,
  "order_direction": "ASC",
  "order_field": "name",
  "query": "Acme",
  "identification": "900123456",
  "name": "Acme S.A.S",
  "type": "client",
  "mode": "simple"
}

Response

Lista de contactos.