Skip to main content
GET
/
v1
/
alarms
/
forecasts
/
get-by-recipient-id
/
{recipientId}
Get by recipient ID
curl --request GET \
  --url https://api.iklim.co/v1/alarms/forecasts/get-by-recipient-id/{recipientId}
{
  "registrations": [
    {
      "registrationId": "f7587d9e-2481-4b4c-818d-c8d1946851b7",
      "recipientId": "customer-system-001",
      "boundary": {
        "cityId": 6,
        "districtId": 557
      },
      "forecastDays": 3,
      "forecastAlarmDelivery": [
        "MORNING",
        "EVENING"
      ],
      "webhook": {
        "accountId": "2f04f1b5-1c0a-4c4e-b0a7-0ba6e9b7f2e1",
        "url": "https://api.customer.com/alerts/forecast-callback",
        "httpMethod": "POST",
        "contentType": "application/json",
        "authentication": {
          "username": "alert-user",
          "password": "******"
        },
        "deliveryPolicy": {
          "timeout": 60,
          "maxRetries": 3,
          "retryDelay": 10
        }
      },
      "filter": {
        "precipitationThreshold": "MODERATE",
        "snowFallThreshold": "LIGHT",
        "windGustThreshold": "STRONG_WIND",
        "hotTemperatureThreshold": "HOT_SNAP",
        "coldTemperatureThreshold": "COLD_SNAP"
      }
    }
  ],
  "totalRecords": 42,
  "pageNumber": 0,
  "pageSize": 20
}

Path Parameters

recipientId
string
required

Recipient identifier

Response

OK

Paginated result set of forecast alarm registrations.

registrations
object[]

List of forecast alarm registrations on the current page.

totalRecords
integer<int32>

Total number of matching registrations across all pages.

Example:

42

pageNumber
integer<int32>

Zero-based index of the returned page.

Example:

0

pageSize
integer<int32>

Maximum number of registrations per page as originally requested.

Example:

20