Get Adhesions
GET
/adhesions/{externalClientId}Consulta las adhesiones activas e inactivas de agenda de un usuario.
Objetivo
Permite obtener las adhesiones que el usuario tenga registradas para un identificador, incluyendo configuraciones de débito automático y alias.
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. |
Query Parameters
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
allAdhesions | Boolean | No | Permite incluir adhesiones inactivas en la respuesta. |
includeNotifications | Boolean | No | Indica si deben incluirse las notificaciones configuradas. |
Response
Response Body
| Parámetro | Tipo | Descripción |
|---|---|---|
adhesions | Object[] | Lista de adhesiones del usuario. |
tx | UUID | ID de transacción. |
mainTx | UUID | ID principal de transacción. |
Response Examples
200 OK
Consideraciones
- El campo externalClientId debe coincidir con el utilizado en la consulta de deuda.
- Puede utilizarse includeNotifications para traer configuraciones adicionales.
- Por defecto solo se devuelven adhesiones activas, usar allAdhesions=true para incluir inactivas.
CLIENT LIBRARIES
REQUEST EXAMPLE
curl --request GET \ --url https://agenda.homo.tapila.cloud/adhesions/user123 \ --header 'x-authorization-token: YOUR_TOKEN_HERE' \ --header 'x-api-key: YOUR_API_KEY_HERE'