Get Notifications
GET
/adhesions/{externalClientId}?includeNotifications=trueConsulta 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
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
x-api-key | String | Sí | API Key para acceder al endpoint. |
x-authorization-token | String | Sí | Token de autenticación válido. |
Path Parameters
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
externalClientId | String | Sí | Identificador único del cliente externo para consultar sus adhesiones y notificaciones. |
Query Parameters
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
includeNotifications | Boolean | Sí | Debe ser true para incluir configuraciones de notificación. |
Response
Response Body
| Parámetro | Tipo | Descripción |
|---|---|---|
notifications | Object[] | Lista de notificaciones configuradas. |
tx | UUID | ID de la transacción. |
mainTx | UUID | ID principal de la transacción. |
Response Examples
200 OK
Consideraciones
- El campo includeNotifications debe estar en true para que el endpoint incluya las notificaciones.
- Es útil para que el cliente administre sus canales y destinatarios configurados.
- Los canales disponibles incluyen EMAIL, SMS y PUSH notifications.
CLIENT LIBRARIES
REQUEST EXAMPLE
curl --request GET \
--url https://agenda.homo.tapila.cloud/adhesions/{externalClientId}?includeNotifications=true \
--header 'x-authorization-token: YOUR_TOKEN_HERE' \
--header 'x-api-key: YOUR_API_KEY_HERE'