Skip to main content
GET
Obtener esquema de contactos
Obtén la definición de los campos disponibles para los contactos de tu cuenta. Consulta este esquema antes de crear filtros para Buscar contactos.

Endpoint

Parámetros de ruta

Ejemplo de solicitud

Respuesta exitosa (200)

La respuesta puede incluir metadatos adicionales. Para integrar contactos utiliza:

Formatos de fecha

Revisa fields[].jsonSchema.format para saber qué valor debes enviar en cada campo: Por ejemplo, si el esquema devuelve los campos del ejemplo anterior, puedes incluirlos al crear o actualizar un contacto:
Incluye siempre el offset (-06:00) o Z cuando envíes una hora. Así evitas que la misma fecha y hora se interprete en zonas horarias distintas.
No uses DD/MM/YYYY ni timestamps Unix en campos configurables con formato date o date-time. createdAt y updatedAt son diferentes: la API los devuelve como timestamps Unix en milisegundos y no debes enviarlos.

Usar el esquema en una búsqueda

Para una coincidencia exacta sobre un campo de texto, toma su id y agrega .keyword:
Para ordenar, usa el id sin modificar:
Usa siempre fields[].id. Las etiquetas de ui.label pueden cambiar y no son propiedades válidas del contacto.

Errores frecuentes

Authorizations

x-ib-api-key
string
header
required

Path Parameters

tenantId
string
required

Identificador de la cuenta asociado a la API key.

Response

Esquema configurado para los contactos de la cuenta.

entityType
string
required
Allowed value: "contact"
fields
object[]
required
version
integer
required
Required range: x >= 1