Tapi Logo

Recomendamos ingresar en Desktop

Nuestra documentación y herramientas de integración están optimizadas para brindarte la mejor experiencia en computadora.

Por favor, accede desde una computadora para continuar.

Referencia API

Obtener Notificaciones

GET/notifications/{externalClientId}

Consulta las adhesiones de agenda junto con las notificaciones configuradas.

Objetivo

Permite recuperar las adhesiones y configuraciones de notificaciones de un usuario final determinado.

Request

Headers

CampoTipoObligatorioDescripción
x-api-key
StringSíAPI Key para acceder al endpoint.
x-authorization-token
StringSíToken de autenticación válido.

Path Parameters

CampoTipoObligatorioDescripción
externalClientId
StringSíIdentificador único del cliente externo para consultar sus adhesiones y notificaciones.

Response

Response Body

ParámetroTipoDescripción
notifications
Object[]Lista de notificaciones con nueva información de factura.
tx
UUIDID de la transacción.
mainTx
UUIDID principal de la transacción.

Consideraciones

  • Este endpoint devuelve las notificaciones configuradas para el usuario identificado por externalClientId.
  • Es útil para que el cliente administre sus canales y destinatarios configurados.
  • Los canales disponibles incluyen EMAIL, SMS y PUSH notifications.
Ver la librería de errores de esta referencia

CLIENT LIBRARIES

REQUEST EXAMPLE

curl --request GET \
--url https://agenda.homo.tapila.cloud/notifications/{externalClientId} \
--header 'x-authorization-token: YOUR_TOKEN_HERE' \
--header 'x-api-key: YOUR_API_KEY_HERE'