CredonixDocs
Referencia de la APIContactos

Listar

Obtén el listado paginado de los contactos de un cliente.

Descripción general

Este endpoint devuelve los contactos adicionales de un cliente, paginados y ordenados por fecha de creación, del más antiguo al más reciente. El tamaño de página es fijo en 20 resultados.

Los contactos son distintos del contacto principal del cliente (contact_name, contact_phone, contact_email y contact_second_email), que se consulta en Consultar cliente.

Requiere el permiso Leer en Clientes.

Endpoint

GEThttps://app.credonix.mx/api/v1/customers/{customerId}/contacts

Path param: customerId — el id del cliente.

Consulta los contactos de un cliente


Query params

ParámetroTipoRequeridoDefaultDescripción
pageinteger ≥ 1No1Página solicitada. El tamaño de página es fijo en 20.

Campos de la respuesta

CampoTipoDescripción
idstringIdentificador del contacto.
customer_idstringid del cliente al que pertenece.
namestringNombre del contacto.
emailstring | nullCorreo.
second_emailstring | nullSegundo correo.
phonestring | nullTeléfono en formato internacional.
second_phonestring | nullSegundo teléfono.
created_atstringFecha de creación (ISO 8601).
updated_atstringFecha de la última actualización (ISO 8601).

Errores

StatusCódigoCausa
400INVALID_PAGEpage no es un número entero entre 1 y 107374183.
403INSUFFICIENT_PERMISSIONSLa API key no tiene el permiso Leer en Clientes.
404NOT_FOUNDEl cliente no existe en esta organización.
Abrir Credonix