GET alerts/recipients
Gets the list of all alert recipients visible to the customer. Available targets: SMS, email and webhook.
Request example
curl --request GET "https://api-asm1.apica.io/v3/alerts/recipients?auth_ticket=C471ADC4-19B4-4219-BBF4-671A97EC653E"
Response body model example and description
[ { "recipient_id": 3456, "targets": [ { "type": "sms", "id": 12, "name": "Email to customer", "to": "support@apica.io", "enabled": true }, { "type": "sms", "id": 12, "name": "Email to customer", "to": "support@apica.io", "enabled": true }, { "type": "email", "id": 12, "name": "Email to customer", "to": "support@apica.io", "enabled": true } ] }, { "recipient_id": 3456, "targets": [ { "type": "sms", "id": 12, "name": "Email to customer", "to": "support@apica.io", "enabled": true }, { "type": "sms", "id": 12, "name": "Email to customer", "to": "support@apica.io", "enabled": true }, { "type": "sms", "id": 12, "name": "Email to customer", "to": "support@apica.io", "enabled": true } ] }, { "recipient_id": 3456, "targets": [ { "type": "email", "id": 12, "name": "Email to customer", "to": "support@apica.io", "enabled": true }, { "type": "sms", "id": 12, "name": "Email to customer", "to": "support@apica.io", "enabled": true }, { "type": "sms", "id": 12, "name": "Email to customer", "to": "support@apica.io", "enabled": true } ] } ]
Name | Type | Description |
---|---|---|
recipient_id | Integer |
The recipient's numeric identity. |
targets | Array |
Supported targets: SMS, email and webhook. |
type | String |
The target's type. |
id | Integer |
The target's numeric identity. |
name | String |
The target's name. |
to | String |
The target's destination. |
enabled | Boolean |
The target is enable. |