Contactos
Listar contactos
Devuelve los contactos (clientes y proveedores) visibles para la clave, paginados por cursor.
contacts:readcontacts:read- 120/min
- Anotación del servidor: Solo lectura
- Anotación del servidor: Idempotente
Resultado
generado desde el esquema
Aislamiento heredado de la cuenta principal: una cuenta de facturación ve también los contactos de su cuenta principal.
Argumentos
Tamaño de página (1-500). Por defecto es 50.
Límites: mín. 1, máx. 500
Cursor opaco de la página que se devuelve. Pasa el valor de pagination. de la respuesta anterior; trátalo como opaco.
Límites: longitud máx. 200
Orden: hasta 3 campos separados por comas, cada uno con un "-" inicial para descendente (p. ej. "-updatedAt,name"). Campos ordenables: createdAt, updatedAt, name, contactType, role, status, email. Por defecto, "-createdAt". Los empates se resuelven por id, así que el orden es estable entre páginas, y un cursor queda ligado al orden con el que se emitió.
Límites: longitud máx. 200
Filtra por tipo de contacto: person (persona física) o company (empresa).
Opciones disponibles: person, company
Filtra por rol del contacto: client, provider, lead, debtor, creditor, student, teacher o unspecified.
Opciones disponibles: client, provider, lead, debtor, creditor, student, teacher, unspecified
Filtra por email: coincide con las direcciones de email del contacto.
Límites: longitud máx. 200
Filtra por teléfono: coincide con los números de teléfono del contacto.
Límites: longitud máx. 200
Filtra según si el contacto tiene acceso a la app: "true" devuelve solo los usuarios de la app, "false" solo los que no lo son. Omítelo para no filtrar.
Ponlo en true para incluir pagination., el número de resultados que coinciden con los filtros en todas las páginas. Desactivado por defecto.
Filtros de fecha por campo. Una fecha sin hora (YYYY-MM-DD) se lee en la zona horaria del negocio; un instante ISO 8601 con desplazamiento se aplica tal cual con gte, lte, gt y lt, mientras que on lo amplía al día completo del negocio que lo contiene. Campos: created, updated.
Mostrar atributos hijosOcultar atributos hijos
Mostrar atributos hijosOcultar atributos hijos
Desde este día o instante, inclusive.
Hasta este día o instante, inclusive.
Estrictamente posterior; una fecha sin hora significa después del final de ese día.
Estrictamente anterior; una fecha sin hora significa antes del inicio de ese día.
Exactamente ese día; un instante significa toda la jornada del negocio que lo contiene.
Mostrar atributos hijosOcultar atributos hijos
Desde este día o instante, inclusive.
Hasta este día o instante, inclusive.
Estrictamente posterior; una fecha sin hora significa después del final de ese día.
Estrictamente anterior; una fecha sin hora significa antes del inicio de ese día.
Exactamente ese día; un instante significa toda la jornada del negocio que lo contiene.
Resultado
En un éxito el resultado lleva structuredContent con data y meta. Estos son los atributos de data.
Ver los atributos de data
Identificador único del contacto.
Nombre del contacto (persona o empresa).
Tipo de contacto: person (particular) o company (negocio).
Opciones disponibles: person, company
Rol del contacto: client, provider, lead, debtor, creditor, student, teacher o unspecified.
Opciones disponibles: client, provider, lead, debtor, creditor, student, teacher, unspecified
Estado del contacto: active (operativo), inactive (desactivado) o archived (cerrado, conservado como histórico).
Opciones disponibles: active, inactive, archived
NIF/CIF o número de identificación fiscal; null si no se ha registrado.
Nombre comercial; null si coincide con el nombre o no consta.
Cargo o puesto de la persona de contacto; null si no está registrado.
Número de contacto asignado por la cuenta (referencia interna); null si no consta.
Lista de direcciones de correo electrónico del contacto.
Mostrar atributos hijosOcultar atributos hijos
Identificador interno del correo electrónico dentro del contacto.
Etiqueta descriptiva del email; null si no tiene.
Dirección de email.
Si este es el email principal del contacto.
Email de facturación dedicado; null significa que se usa el email principal.
Lista de teléfonos del contacto.
Mostrar atributos hijosOcultar atributos hijos
Identificador interno del teléfono dentro del contacto.
Etiqueta descriptiva del teléfono; null si no tiene.
Número de teléfono.
Prefijo telefónico internacional del país (p. ej. "+34"); null si no consta.
Si este es el teléfono principal del contacto.
Lista de sitios web del contacto.
Mostrar atributos hijosOcultar atributos hijos
Identificador interno del sitio web dentro del contacto.
Etiqueta descriptiva del sitio web; null si no tiene.
URL del sitio web.
Lista de direcciones del contacto.
Mostrar atributos hijosOcultar atributos hijos
Identificador interno de la dirección dentro del contacto.
Etiqueta descriptiva de la dirección; null si no tiene.
Primera línea de la dirección; null si no consta.
Segunda línea de la dirección; null si no consta.
Ciudad; null si no consta.
Provincia o región; null si no se ha registrado.
Código postal; null si no se ha registrado.
País; null si no consta.
Si esta es la dirección principal del contacto.
Carpeta o agrupación organizativa; null si el contacto no está clasificado.
Porcentaje de descuento general del contacto (0-100); null si no hay descuento configurado.
Idioma preferido del contacto; null si no se ha registrado.
Moneda por defecto del contacto como código ISO 4217; null si no consta.
Método de pago preferido del contacto; null si no está configurado.
Mostrar atributos hijosOcultar atributos hijos
Tipo de método de pago: bank_transfer, card, cash, sepa_direct_debit u other.
Opciones disponibles: bank_transfer, card, cash, other, sepa_direct_debit
Detalle en texto libre cuando el tipo es "other" (por ejemplo, un método registrado antes de configurarse); null en caso contrario.
Días del mes en que el contacto hace pagos; null si no está configurado.
Días de vencimiento por defecto de las facturas del contacto; null si no está configurado.
Si el contacto está suscrito a comunicaciones de marketing.
Si el contacto tiene acceso a la app.
Valores de los campos personalizados por identificador de campo personalizado; las definiciones están en /api.
Fecha de creación en ISO 8601 con desplazamiento.
Fecha de la última actualización en ISO 8601 con desplazamiento.
Un error es un resultado con isError: true y el problema en content[0].; no hay structuredContent. Consulta Errores.
Prompts de ejemplo
Lista mis clientes cuyo nombre empieza por «Northwind».
La misma operación por REST
Esta herramienta ejecuta GET /api/v1/contacts.
Páginas relacionadas
Enlace a esta sección: Páginas relacionadasContactos
Listar contactos
Devuelve los contactos (clientes y proveedores) visibles para la clave, paginados por cursor.
Guías
Escrituras seguras
Un asistente que puede escribir también puede escribir lo equivocado. Decide qué herramientas necesitan a una persona, reintenta sin duplicar y sabe qué pone en marcha una escritura.
Guías
Errores
Un error de herramienta es un resultado con
isError: truey el problema en el primer bloque de texto. Ramifica por sucode.
¿Te ha resultado útil esta página?