GET   alerts/recipients/{recipient_id}/details

Gets a information about the alert recipient matching the provided recipient_id. Available targets: SMS, email and webhook.

URL Parameters

Name	Description
recipient_id	Recipient Id. Type: numeric.

Request example

curl --request GET "https://api-asm1.apica.io/v3/alerts/recipients/567/details?auth_ticket=C471ADC4-19B4-4219-BBF4-671A97EC653E"

Response body model example and description

{
  "AlerterTargetUser": {
    "Id": 1,
    "Name": "sample string 2",
    "Description": "sample string 3",
    "CustomerId": 4,
    "UserId": "815ac100-4452-4d86-bb9f-e492a8e9ea44",
    "AlerterTargetUsersMappings": [
      {
        "Id": 1,
        "TargetId": 2,
        "UserId": 3,
        "TargetType": 0
      },
      {
        "Id": 1,
        "TargetId": 2,
        "UserId": 3,
        "TargetType": 0
      },
      {
        "Id": 1,
        "TargetId": 2,
        "UserId": 3,
        "TargetType": 0
      }
    ],
    "AlerterSmsTargetUsers": [
      {
        "Id": 1,
        "SmsTargetId": 2,
        "TargetUserId": 3
      },
      {
        "Id": 1,
        "SmsTargetId": 2,
        "TargetUserId": 3
      },
      {
        "Id": 1,
        "SmsTargetId": 2,
        "TargetUserId": 3
      }
    ],
    "AlerterSmtpTargetUsers": [
      {
        "Id": 1,
        "SmtpTargetId": 2,
        "TargetUserId": 3
      },
      {
        "Id": 1,
        "SmtpTargetId": 2,
        "TargetUserId": 3
      },
      {
        "Id": 1,
        "SmtpTargetId": 2,
        "TargetUserId": 3
      }
    ],
    "AlerterCliTargetUsers": [
      {
        "Id": 1,
        "CliTargetId": 2,
        "TargetUserId": 3
      },
      {
        "Id": 1,
        "CliTargetId": 2,
        "TargetUserId": 3
      },
      {
        "Id": 1,
        "CliTargetId": 2,
        "TargetUserId": 3
      }
    ],
    "AlerterPagerDutyTargetUsers": [
      {
        "Id": 1,
        "PagerdutyTargetId": 2,
        "TargetuserId": 3
      },
      {
        "Id": 1,
        "PagerdutyTargetId": 2,
        "TargetuserId": 3
      },
      {
        "Id": 1,
        "PagerdutyTargetId": 2,
        "TargetuserId": 3
      }
    ],
    "AlerterWebHookTargetUsers": [
      {
        "Id": 1,
        "WebhookTargetId": 2,
        "TargetUserId": 3
      },
      {
        "Id": 1,
        "WebhookTargetId": 2,
        "TargetUserId": 3
      },
      {
        "Id": 1,
        "WebhookTargetId": 2,
        "TargetUserId": 3
      }
    ]
  },
  "Targets": null
}

Name	Type	Description
AlerterTargetUser	Object	No documentation available.
Id	Integer	No documentation available.
Name	String	No documentation available.
Description	String	No documentation available.
CustomerId	Integer	No documentation available.
UserId	Guid	No documentation available.
AlerterTargetUsersMappings	Array	No documentation available.
Id	Integer	No documentation available.
TargetId	Integer	No documentation available.
UserId	Integer	No documentation available.
TargetType	Object	No documentation available.
value__	Integer	No documentation available.
AlerterSmsTargetUsers	Array	No documentation available.
Id	Integer	No documentation available.
SmsTargetId	Integer	No documentation available.
TargetUserId	Integer	No documentation available.
AlerterSmtpTargetUsers	Array	No documentation available.
Id	Integer	No documentation available.
SmtpTargetId	Integer	No documentation available.
TargetUserId	Integer	No documentation available.
AlerterCliTargetUsers	Array	No documentation available.
Id	Integer	No documentation available.
CliTargetId	Integer	No documentation available.
TargetUserId	Integer	No documentation available.
AlerterPagerDutyTargetUsers	Array	No documentation available.
Id	Integer	No documentation available.
PagerdutyTargetId	Integer	No documentation available.
TargetuserId	Integer	No documentation available.
AlerterWebHookTargetUsers	Array	No documentation available.
Id	Integer	No documentation available.
WebhookTargetId	Integer	No documentation available.
TargetUserId	Integer	No documentation available.
Targets	Array	No documentation available.
TargetType	Object	No documentation available.
value__	Integer	No documentation available.
Id	Integer	No documentation available.
AlerterId	Integer	No documentation available.
TargetName	String	No documentation available.
Enabled	Integer	No documentation available.
Valid	Integer	No documentation available.
LimitId	Integer	No documentation available.
CreatedUtc	DateTime	No documentation available.
UpdatedUtc	DateTime	No documentation available.
DisplayValue	String	No documentation available.
Users	Array	No documentation available.