> ## Documentation Index > Fetch the complete documentation index at: https://api-docs.iklim.co/llms.txt > Use this file to discover all available pages before exploring further. # Get registration by ID > Returns a single point alarm registration using its unique identifier. ## OpenAPI ````yaml /open-api/en/point-alarm_version-1.json get /v1/alarms/points/get-by-id/{registrationId} openapi: 3.1.0 info: title: OpenAPI definition version: v0 servers: - url: https://api.iklim.co description: Production server - url: https://api-test.iklim.co description: Test server security: [] tags: - name: Point Alarms description: Register, list and manage point-based severe weather alarm subscriptions. paths: /v1/alarms/points/get-by-id/{registrationId}: get: tags: - Point Alarms summary: Get registration by ID description: Returns a single point alarm registration using its unique identifier. operationId: getById parameters: - name: registrationId in: path required: true schema: type: string minLength: 1 responses: '200': description: Registration returned successfully content: application/json: schema: $ref: '#/components/schemas/RegistrationResponse' '400': description: Bad Request content: '*/*': schema: $ref: '#/components/schemas/StandardErrorResponse' '401': description: Unauthorized content: '*/*': schema: $ref: '#/components/schemas/StandardErrorResponse' '402': description: Paid Subscription Required content: application/json: schema: $ref: '#/components/schemas/StandardErrorResponse' '403': description: Forbidden/Not Allowed content: application/json: schema: $ref: '#/components/schemas/StandardErrorResponse' '429': description: Subscription Limits For This Service is Exceeded content: application/json: schema: $ref: '#/components/schemas/StandardErrorResponse' '500': description: Internal Server Error During Request content: application/json: schema: $ref: '#/components/schemas/StandardErrorResponse' components: schemas: RegistrationResponse: type: object properties: registrationId: type: string format: uuid description: Existing registration UUID. Omit for create; required for update. example: f7587d9e-2481-4b4c-818d-c8d1946851b7 recipientId: type: string description: Recipient identifier example: Recipient1 boundary: $ref: '#/components/schemas/Boundary' description: Geospatial boundary definition for the alarm (point+radius) webhook: $ref: '#/components/schemas/Webhook' description: Webhook configuration for alarm callbacks filter: $ref: '#/components/schemas/Filter' description: Event filters to apply (lightning, thunderstorm, precipitation) createdAt: type: string format: date-time description: Creation timestamp (UTC) example: '2025-06-25T11:15:41Z' updatedAt: type: string format: date-time description: Last update timestamp (UTC) example: '2025-06-30T10:05:12Z' StandardErrorResponse: type: object description: Standard API error response structure properties: timestamp: type: string format: date-time description: Timestamp when the error occurred example: YYYY-mm-DDTHH:MM:SS.nnnnnnnnn status: type: integer format: int32 description: HTTP status code example: XXX error: type: string description: Error name or type example: Error Name minLength: 1 message: type: string description: Main error message example: Error Message minLength: 1 messages: type: array description: Additional detailed error messages items: type: string path: type: string description: Request path that caused the error example: /endpoint/uri/here minLength: 1 required: - error - message - path - status - timestamp Boundary: type: object properties: point: $ref: '#/components/schemas/GeoPoint' description: Center point (lat/lng) example: lat: 39.9208 lng: 32.8541 radius: type: number format: double description: Radius in meters example: 10000 Webhook: type: object description: >-

Outbound callback configuration for alarm notifications

When the first alarm record is created for a user account, the webhook information provided in the request is stored and associated with that account. Only one webhook can be defined per account. This association is not related to recipientId; it is directly tied to the account of the user logged into the service. If the webhook needs to be modified, the update service must be used.

For subsequent alarm records, sending the webhook information again is not required. In such cases, the previously defined webhook for the requesting user’s account is used automatically. The accountId field within the webhook object is optional; if provided, the webhook of the corresponding account is applied, and if omitted, the default webhook of the requesting user’s account is used.

Users with the POWER_USER or ADMIN role may create alarm records on behalf of another account by specifying that account’s accountId. This is only possible if the target account already has at least one existing alarm record—and therefore a webhook—registered in the system. If no webhook exists for the target account, it must be created first.

properties: accountId: type: string format: uuid description: >- Account UUID owning this webhook (optional; defaults to caller account). example: 2f04f1b5-1c0a-4c4e-b0a7-0ba6e9b7f2e1 url: type: string description: Destination HTTPS endpoint to receive callbacks. example: https://api.customer.com/alerts/callback httpMethod: type: string description: HTTP method to use when delivering payloads. enum: - POST - PUT - GET example: POST contentType: type: string description: Content type of the delivered payload. example: application/json authentication: $ref: '#/components/schemas/AuthWrapper' description: Authentication settings for securing deliveries. requestHeaders: $ref: '#/components/schemas/MapTypeSchema' description: >- Custom HTTP headers to include with every webhook delivery request. Format: {"Header-Name":"value","Another-Header":"value"} example: source: iklim.co custom-header: value deliveryPolicy: $ref: '#/components/schemas/DeliveryPolicy' description: Delivery policy (timeouts & retries). Filter: type: object properties: lightning: $ref: '#/components/schemas/LightningFilter' description: swagger.schema.alarms.point.filter.lightning thunderstorm: $ref: '#/components/schemas/ThunderstormFilter' description: swagger.schema.alarms.point.filter.thunderstorm precipitation: $ref: '#/components/schemas/PrecipitationFilter' description: swagger.schema.alarms.point.filter.precipitation GeoPoint: type: object properties: lng: type: number format: double description: Longitude coordinate. example: 32.857358 maximum: 180 minimum: -180 lat: type: number format: double description: Latitude coordinate. example: 39.93504 maximum: 90 minimum: -90 required: - lat - lng AuthWrapper: description: Authentication envelope with discriminator field "type". discriminator: propertyName: type mapping: BASIC: $ref: '#/components/schemas/BasicAuthentication' JWT_TOKEN: $ref: '#/components/schemas/JwtAuthentication' API_KEY: $ref: '#/components/schemas/ApiKeyAuthentication' HMAC_SIGNATURE: $ref: '#/components/schemas/HmacAuthentication' oneOf: - $ref: '#/components/schemas/BasicAuthentication' - $ref: '#/components/schemas/JwtAuthentication' - $ref: '#/components/schemas/ApiKeyAuthentication' - $ref: '#/components/schemas/HmacAuthentication' MapTypeSchema: type: object example: key-1: value-1 key-2: value-2 properties: key: type: string example: key-1 value: type: string example: value-1 DeliveryPolicy: type: object description: Delivery timeout and retry behavior. properties: timeout: type: integer format: int64 description: Request timeout in seconds. example: 60 maxRetries: type: integer format: int32 description: Maximum number of retry attempts. example: 3 retryDelay: type: integer format: int32 description: Delay between retries in seconds. example: 10 LightningFilter: type: object description: Lightning event filter properties: type: type: string description: Lightning event type enum: - FLASH_CLOUD_TO_GROUND - PULSE_IN_CLOUD example: FLASH_CLOUD_TO_GROUND peakCurrent: type: number format: double description: Peak current (Amp, negative for CG strikes typical) example: -12.5 inCloudHeight: type: number format: double description: In-cloud discharge height (meters) example: 4500 ThunderstormFilter: type: object description: Thunderstorm event filter properties: intersectsAffectedPolygon: type: boolean description: Event affected area polygon must intersect registered polygon example: true intersectsCellPolygon: type: boolean description: Event cell polygon must intersect registered polygon example: false severityThreshold: type: string description: Minimum severity threshold to trigger enum: - LOW - MEDIUM - HIGH example: MEDIUM speedThreshold: type: number format: double description: Minimum storm speed (km/h) example: 20 PrecipitationFilter: type: object description: Precipitation event filter properties: intensities: type: array description: Allowed precipitation intensities example: - LIGHT - MODERATE items: type: string enum: - DRIZZLE - LIGHT - MODERATE - HEAVY - VERY_HEAVY - EXTREME BasicAuthentication: type: object description: HTTP Basic authentication. properties: type: type: string description: Authentication type discriminator. enum: - BASIC - JWT_TOKEN - API_KEY - HMAC_SIGNATURE example: API_KEY writeOnly: true username: type: string description: Username for Basic auth. example: alert-user password: type: string description: Password for Basic auth. example: '******' JwtAuthentication: type: object description: Bearer JWT token authentication. properties: type: type: string description: Authentication type discriminator. enum: - BASIC - JWT_TOKEN - API_KEY - HMAC_SIGNATURE example: API_KEY writeOnly: true jwtToken: type: string description: Pre-issued JWT token to include as Authorization header. example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.... ApiKeyAuthentication: type: object description: API key authentication (header and/or query). properties: type: type: string description: Authentication type discriminator. enum: - BASIC - JWT_TOKEN - API_KEY - HMAC_SIGNATURE example: API_KEY writeOnly: true apiKey: type: string description: API key value to send with request. example: x-1234567890abcdef asQueryParameter: type: boolean description: If true, send API key as query parameter. example: false asHeader: type: boolean description: If true, send API key as request header. example: true HmacAuthentication: type: object description: HMAC signature authentication with clientId/secret. properties: type: type: string description: Authentication type discriminator. enum: - BASIC - JWT_TOKEN - API_KEY - HMAC_SIGNATURE example: API_KEY writeOnly: true clientId: type: string description: Client identifier used in signature preimage. example: bem-portal secret: type: string description: Shared secret used to compute HMAC. example: '******' algorithm: type: string description: HMAC algorithm to use. enum: - HmacSHA1 - HmacSHA256 - HmacSHA384 - HmacSHA512 - HmacMD5 example: HmacSHA256 ````