Skip to main content
GET
/
v1
/
alarms
/
forecasts
/
get-by-id
/
{registrationId}
Get by registration ID
curl --request GET \
  --url https://api.iklim.co/v1/alarms/forecasts/get-by-id/{registrationId}
import requests

url = "https://api.iklim.co/v1/alarms/forecasts/get-by-id/{registrationId}"

response = requests.get(url)

print(response.text)
const options = {method: 'GET'};

fetch('https://api.iklim.co/v1/alarms/forecasts/get-by-id/{registrationId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.iklim.co/v1/alarms/forecasts/get-by-id/{registrationId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.iklim.co/v1/alarms/forecasts/get-by-id/{registrationId}"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.iklim.co/v1/alarms/forecasts/get-by-id/{registrationId}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.iklim.co/v1/alarms/forecasts/get-by-id/{registrationId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
{
  "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": "******"
    },
    "requestHeaders": {
      "source": "iklim.co",
      "custom-header": "value"
    },
    "deliveryPolicy": {
      "timeout": 60,
      "maxRetries": 3,
      "retryDelay": 10
    }
  },
  "filter": {
    "precipitationThreshold": "MODERATE",
    "snowFallThreshold": "LIGHT",
    "windGustThreshold": "STRONG_WIND",
    "hotTemperatureThreshold": "HOT_SNAP",
    "coldTemperatureThreshold": "COLD_SNAP"
  },
  "createdAt": "2025-01-01T10:15:30Z",
  "updatedAt": "2025-01-01T11:15:30Z",
  "warnings": [
    "warning-1",
    "warning-2"
  ]
}
{
  "timestamp": "YYYY-mm-DDTHH:MM:SS.nnnnnnnnn",
  "status": "XXX",
  "error": "Error Name",
  "message": "Error Message",
  "path": "/endpoint/uri/here",
  "messages": [
    "<string>"
  ]
}
{
  "timestamp": "YYYY-mm-DDTHH:MM:SS.nnnnnnnnn",
  "status": "XXX",
  "error": "Error Name",
  "message": "Error Message",
  "path": "/endpoint/uri/here",
  "messages": [
    "<string>"
  ]
}
{
  "timestamp": "YYYY-mm-DDTHH:MM:SS.nnnnnnnnn",
  "status": "XXX",
  "error": "Error Name",
  "message": "Error Message",
  "path": "/endpoint/uri/here",
  "messages": [
    "<string>"
  ]
}
{
  "timestamp": "YYYY-mm-DDTHH:MM:SS.nnnnnnnnn",
  "status": "XXX",
  "error": "Error Name",
  "message": "Error Message",
  "path": "/endpoint/uri/here",
  "messages": [
    "<string>"
  ]
}

Path Parameters

registrationId
string
required

Registration UUID

Response

OK

registrationId
string<uuid>

UUID of the registration record (required for update operations).

Example:

"f7587d9e-2481-4b4c-818d-c8d1946851b7"

recipientId
string

Caller-defined external reference identifier for the notification recipient.

Example:

"customer-system-001"

boundary
object

Alarm registration boundary

Defines the geographic scope to monitor for forecast alarm conditions. The concrete boundary type is selected via the type discriminator field; supply only the fields that belong to the chosen subtype.

  • ADMINISTRATIVE – boundary identified by a city (cityId) and a district (districtId); both fields are required.
  • POINT – boundary defined by a single longitude/latitude coordinate (point). The alarm evaluates forecast data for the nearest forecast grid cell to that coordinate.
forecastDays
integer<int32>

Number of forecast days ahead to evaluate for alarm conditions (1–14).

Example:

3

forecastAlarmDelivery
enum<string>[]

Time windows at which alarm notifications are dispatched (MORNING – 04:00 UTC, EVENING – 16:00 UTC).

Available options:
MORNING,
EVENING
Example:
["MORNING", "EVENING"]
webhook
object

Outbound callback configuration for this registration.

filter
object

Threshold filters that control which forecast conditions trigger an alarm.

createdAt
string<date-time>

Timestamp when the registration was first created (ISO-8601).

Example:

"2025-01-01T10:15:30Z"

updatedAt
string<date-time>

Timestamp of the most recent update to the registration (ISO-8601).

Example:

"2025-01-01T11:15:30Z"

warnings
string[]

Non-fatal warnings generated during registration processing.

Example:
["warning-1", "warning-2"]