ilert

ilert Notification Preferences API

The Notification Preferences API from ilert — 8 operation(s) for notification preferences.

GitHub OpenAPI
Business capability
Incident Response Management BC-4220.30

Operations 20

GET /users/{user-id}/notification-preferences/alerts Get alert notification preferences of a user #
POST /users/{user-id}/notification-preferences/alerts Create an alert notification preference #
GET /users/{user-id}/notification-preferences/alerts/{id} Get specific notification preferences alert #
PUT /users/{user-id}/notification-preferences/alerts/{id} Update a user's alert notification preference #
DELETE /users/{user-id}/notification-preferences/alerts/{id} Delete the user's specified notification preferences alert #
GET /users/{user-id}/notification-preferences/duties Get duty notification preferences of a user #
POST /users/{user-id}/notification-preferences/duties Create a duty notification preference #
GET /users/{user-id}/notification-preferences/duties/{id} Get specific notification preferences duty #
PUT /users/{user-id}/notification-preferences/duties/{id} Update a user's duty notification preference #
DELETE /users/{user-id}/notification-preferences/duties/{id} Delete the user's specified notification preferences duty #
GET /users/{user-id}/notification-preferences/updates Get update notification preferences of a user #
POST /users/{user-id}/notification-preferences/updates Create an update notification preference #
GET /users/{user-id}/notification-preferences/updates/{id} Get specific notification preferences update #
PUT /users/{user-id}/notification-preferences/updates/{id} Update a user's update notification preference #
DELETE /users/{user-id}/notification-preferences/updates/{id} Delete the user's specified notification preferences update #
GET /users/{user-id}/notification-preferences/subscriptions Get subscription notification preferences of a user #
POST /users/{user-id}/notification-preferences/subscriptions Create a subscription notification preference #
GET /users/{user-id}/notification-preferences/subscriptions/{id} Get specific notification preferences subscription #
PUT /users/{user-id}/notification-preferences/subscriptions/{id} Update a user's subscription notification preference #
DELETE /users/{user-id}/notification-preferences/subscriptions/{id} Delete the user's specified notification preferences subscription #

Documentation

📖
Documentation
https://docs.ilert.com/developer-docs/rest-api/api-reference
📖
Authentication
https://docs.ilert.com/developer-docs/rest-api/api-reference/introduction/authentication
📖
RateLimits
https://docs.ilert.com/developer-docs/rest-api/alertsource-throttle

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/ilert/refs/heads/main/openapi/ilert-notification-preferences-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/ilert/refs/heads/main/json-schema/

Other Resources

🔗
APIVersionHistory
https://docs.ilert.com/developer-docs/api-version-history
🔗
APISamples
https://docs.ilert.com/developer-docs/api-samples
🔗
GoSDK
https://github.com/iLert/ilert-go
🔗
JavaScriptSDK
https://github.com/iLert/ilert-js
🔗
RustSDK
https://github.com/iLert/ilert-rust
🔗
TerraformProvider
https://github.com/iLert/terraform-provider-ilert
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/ilert/refs/heads/main/examples/
🔗
Vocabulary
https://raw.githubusercontent.com/api-evangelist/ilert/refs/heads/main/vocabulary/ilert-vocabulary.yml
🔗
JSONLDContext
https://raw.githubusercontent.com/api-evangelist/ilert/refs/heads/main/json-ld/ilert-context.jsonld

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/ilert-notification-preferences-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

ilert-notification-preferences-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: ilert REST Notification Preferences API
  description: '# Introduction

    The ilert API is a RESTful API and provides programmatic access to entities in ilert and lets you easily integrate ilert with 3rd party tools.'
  version: v2.2026.5-r.3
  x-logo:
    url: ./ilert-logo-spaced.png
    backgroundColor: '#fafafa'
    altText: ilert documentation logo
servers:
- url: /api
security:
- apiKey: []
tags:
- name: Notification Preferences
paths:
  /users/{user-id}/notification-preferences/alerts:
    get:
      tags:
      - Notification Preferences
      summary: Get alert notification preferences of a user
      parameters:
      - name: user-id
        in: path
        description: numeric user id
        required: true
        schema:
          type: string
      responses:
        '200':
          description: the response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/NotificationPreferencesAlert'
      operationId: getUsersByUserIdNotificationPreferencesAlerts
      x-operation-id-source: derived
    post:
      tags:
      - Notification Preferences
      summary: Create an alert notification preference
      parameters:
      - name: user-id
        in: path
        description: numeric user id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NotificationPreferencesAlertPost'
        required: true
      responses:
        '201':
          description: the response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationPreferencesAlert'
      x-codegen-request-body-name: alert notification preference
      operationId: postUsersByUserIdNotificationPreferencesAlerts
      x-operation-id-source: derived
  /users/{user-id}/notification-preferences/alerts/{id}:
    get:
      tags:
      - Notification Preferences
      summary: Get specific notification preferences alert
      parameters:
      - name: user-id
        in: path
        description: numeric user id
        required: true
        schema:
          type: string
      - name: id
        in: path
        description: entity ID
        required: true
        schema:
          type: number
      responses:
        '200':
          description: the response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationPreferencesAlert'
      operationId: getUsersByUserIdNotificationPreferencesAlertsById
      x-operation-id-source: derived
    put:
      tags:
      - Notification Preferences
      summary: Update a user's alert notification preference
      parameters:
      - name: user-id
        in: path
        description: numeric user id
        required: true
        schema:
          type: string
      - name: id
        in: path
        description: entity ID
        required: true
        schema:
          type: number
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NotificationPreferencesAlertPost'
        required: false
      responses:
        '200':
          description: the response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationPreferencesAlert'
      x-codegen-request-body-name: alert notification preference
      operationId: putUsersByUserIdNotificationPreferencesAlertsById
      x-operation-id-source: derived
    delete:
      tags:
      - Notification Preferences
      summary: Delete the user's specified notification preferences alert
      parameters:
      - name: user-id
        in: path
        description: numeric user id
        required: true
        schema:
          type: string
      - name: id
        in: path
        description: entity ID
        required: true
        schema:
          type: number
      responses:
        '204':
          description: if deletion was successful
          content: {}
      operationId: deleteUsersByUserIdNotificationPreferencesAlertsById
      x-operation-id-source: derived
  /users/{user-id}/notification-preferences/duties:
    get:
      tags:
      - Notification Preferences
      summary: Get duty notification preferences of a user
      parameters:
      - name: user-id
        in: path
        description: numeric user id
        required: true
        schema:
          type: string
      responses:
        '200':
          description: the response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/NotificationPreferencesDuty'
      operationId: getUsersByUserIdNotificationPreferencesDuties
      x-operation-id-source: derived
    post:
      tags:
      - Notification Preferences
      summary: Create a duty notification preference
      parameters:
      - name: user-id
        in: path
        description: numeric user id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NotificationPreferencesDutyPost'
        required: true
      responses:
        '201':
          description: the response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationPreferencesDuty'
      x-codegen-request-body-name: duty notification preference
      operationId: postUsersByUserIdNotificationPreferencesDuties
      x-operation-id-source: derived
  /users/{user-id}/notification-preferences/duties/{id}:
    get:
      tags:
      - Notification Preferences
      summary: Get specific notification preferences duty
      parameters:
      - name: user-id
        in: path
        description: numeric user id
        required: true
        schema:
          type: string
      - name: id
        in: path
        description: entity ID
        required: true
        schema:
          type: number
      responses:
        '200':
          description: the response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationPreferencesDuty'
      operationId: getUsersByUserIdNotificationPreferencesDutiesById
      x-operation-id-source: derived
    put:
      tags:
      - Notification Preferences
      summary: Update a user's duty notification preference
      parameters:
      - name: user-id
        in: path
        description: numeric user id
        required: true
        schema:
          type: string
      - name: id
        in: path
        description: entity ID
        required: true
        schema:
          type: number
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NotificationPreferencesDutyPost'
        required: false
      responses:
        '200':
          description: the response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationPreferencesDuty'
      x-codegen-request-body-name: duty notification preference
      operationId: putUsersByUserIdNotificationPreferencesDutiesById
      x-operation-id-source: derived
    delete:
      tags:
      - Notification Preferences
      summary: Delete the user's specified notification preferences duty
      parameters:
      - name: user-id
        in: path
        description: numeric user id
        required: true
        schema:
          type: string
      - name: id
        in: path
        description: entity ID
        required: true
        schema:
          type: number
      responses:
        '204':
          description: if deletion was successful
          content: {}
      operationId: deleteUsersByUserIdNotificationPreferencesDutiesById
      x-operation-id-source: derived
  /users/{user-id}/notification-preferences/updates:
    get:
      tags:
      - Notification Preferences
      summary: Get update notification preferences of a user
      parameters:
      - name: user-id
        in: path
        description: numeric user id
        required: true
        schema:
          type: string
      responses:
        '200':
          description: the response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/NotificationPreferencesUpdate'
      operationId: getUsersByUserIdNotificationPreferencesUpdates
      x-operation-id-source: derived
    post:
      tags:
      - Notification Preferences
      summary: Create an update notification preference
      parameters:
      - name: user-id
        in: path
        description: numeric user id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NotificationPreferencesUpdatePost'
        required: true
      responses:
        '201':
          description: the response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationPreferencesUpdate'
      x-codegen-request-body-name: update notification preference
      operationId: postUsersByUserIdNotificationPreferencesUpdates
      x-operation-id-source: derived
  /users/{user-id}/notification-preferences/updates/{id}:
    get:
      tags:
      - Notification Preferences
      summary: Get specific notification preferences update
      parameters:
      - name: user-id
        in: path
        description: numeric user id
        required: true
        schema:
          type: string
      - name: id
        in: path
        description: entity ID
        required: true
        schema:
          type: number
      responses:
        '200':
          description: the response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationPreferencesUpdate'
      operationId: getUsersByUserIdNotificationPreferencesUpdatesById
      x-operation-id-source: derived
    put:
      tags:
      - Notification Preferences
      summary: Update a user's update notification preference
      parameters:
      - name: user-id
        in: path
        description: numeric user id
        required: true
        schema:
          type: string
      - name: id
        in: path
        description: entity ID
        required: true
        schema:
          type: number
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NotificationPreferencesUpdatePost'
        required: false
      responses:
        '200':
          description: the response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationPreferencesUpdate'
      x-codegen-request-body-name: update notification preference
      operationId: putUsersByUserIdNotificationPreferencesUpdatesById
      x-operation-id-source: derived
    delete:
      tags:
      - Notification Preferences
      summary: Delete the user's specified notification preferences update
      parameters:
      - name: user-id
        in: path
        description: numeric user id
        required: true
        schema:
          type: string
      - name: id
        in: path
        description: entity ID
        required: true
        schema:
          type: number
      responses:
        '204':
          description: if deletion was successful
          content: {}
      operationId: deleteUsersByUserIdNotificationPreferencesUpdatesById
      x-operation-id-source: derived
  /users/{user-id}/notification-preferences/subscriptions:
    get:
      tags:
      - Notification Preferences
      summary: Get subscription notification preferences of a user
      parameters:
      - name: user-id
        in: path
        description: numeric user id
        required: true
        schema:
          type: string
      responses:
        '200':
          description: the response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/NotificationPreferencesSubscription'
      operationId: getUsersByUserIdNotificationPreferencesSubscriptions
      x-operation-id-source: derived
    post:
      tags:
      - Notification Preferences
      summary: Create a subscription notification preference
      parameters:
      - name: user-id
        in: path
        description: numeric user id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NotificationPreferencesSubscriptionPost'
        required: true
      responses:
        '201':
          description: the response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationPreferencesSubscription'
      x-codegen-request-body-name: subscription notification preference
      operationId: postUsersByUserIdNotificationPreferencesSubscriptions
      x-operation-id-source: derived
  /users/{user-id}/notification-preferences/subscriptions/{id}:
    get:
      tags:
      - Notification Preferences
      summary: Get specific notification preferences subscription
      parameters:
      - name: user-id
        in: path
        description: numeric user id
        required: true
        schema:
          type: string
      - name: id
        in: path
        description: entity ID
        required: true
        schema:
          type: number
      responses:
        '200':
          description: the response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationPreferencesSubscription'
      operationId: getUsersByUserIdNotificationPreferencesSubscriptionsById
      x-operation-id-source: derived
    put:
      tags:
      - Notification Preferences
      summary: Update a user's subscription notification preference
      parameters:
      - name: user-id
        in: path
        description: numeric user id
        required: true
        schema:
          type: string
      - name: id
        in: path
        description: entity ID
        required: true
        schema:
          type: number
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NotificationPreferencesSubscriptionPost'
        required: false
      responses:
        '200':
          description: the response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationPreferencesSubscription'
      x-codegen-request-body-name: subscription notification preference
      operationId: putUsersByUserIdNotificationPreferencesSubscriptionsById
      x-operation-id-source: derived
    delete:
      tags:
      - Notification Preferences
      summary: Delete the user's specified notification preferences subscription
      parameters:
      - name: user-id
        in: path
        description: numeric user id
        required: true
        schema:
          type: string
      - name: id
        in: path
        description: entity ID
        required: true
        schema:
          type: number
      responses:
        '204':
          description: if deletion was successful
          content: {}
      operationId: deleteUsersByUserIdNotificationPreferencesSubscriptionsById
      x-operation-id-source: derived
components:
  schemas:
    NotificationPreferencesDutyPost:
      type: object
      properties:
        beforeMin:
          $ref: '#/components/schemas/NotificationPreferencesDutyBeforeMin'
        contact:
          type: object
          oneOf:
          - $ref: '#/components/schemas/ContactPhoneNumber'
          - $ref: '#/components/schemas/ContactEmail'
        method:
          $ref: '#/components/schemas/NotificationPreferenceDutyMethod'
        type:
          $ref: '#/components/schemas/NotificationPreferencesDutyTypes'
    NotificationPreferencesAlertDelayMin:
      type: integer
    NotificationPreferenceAlertType:
      type: string
      enum:
      - LOW_PRIORITY
      - HIGH_PRIORITY
    ContactStatus:
      type: string
      enum:
      - OK
      - LOCKED
      - BLACKLISTED
    NotificationPreferencesSubscription:
      type: object
      properties:
        id:
          type: integer
          format: int64
        contact:
          type: object
          oneOf:
          - $ref: '#/components/schemas/ContactPhoneNumber'
          - $ref: '#/components/schemas/ContactEmail'
        method:
          $ref: '#/components/schemas/NotificationPreferenceSubscriptionMethod'
    NotificationPreferencesUpdate:
      type: object
      properties:
        id:
          type: integer
          format: int64
        contact:
          type: object
          oneOf:
          - $ref: '#/components/schemas/ContactPhoneNumber'
          - $ref: '#/components/schemas/ContactEmail'
        method:
          $ref: '#/components/schemas/NotificationPreferenceUpdateMethod'
        type:
          $ref: '#/components/schemas/NotificationPreferencesUpdateType'
    ContactEmail:
      type: object
      properties:
        id:
          type: integer
          format: int64
        target:
          type: string
        status:
          $ref: '#/components/schemas/ContactStatus'
    NotificationPreferencesDuty:
      type: object
      properties:
        id:
          type: integer
          format: int64
        beforeMin:
          $ref: '#/components/schemas/NotificationPreferencesDutyBeforeMin'
        contact:
          type: object
          oneOf:
          - $ref: '#/components/schemas/ContactPhoneNumber'
          - $ref: '#/components/schemas/ContactEmail'
        method:
          $ref: '#/components/schemas/NotificationPreferenceDutyMethod'
        type:
          $ref: '#/components/schemas/NotificationPreferencesDutyTypes'
    NotificationPreferencesAlertPost:
      type: object
      properties:
        method:
          $ref: '#/components/schemas/NotificationPreferenceAlertMethod'
        contact:
          type: object
          oneOf:
          - $ref: '#/components/schemas/ContactPhoneNumber'
          - $ref: '#/components/schemas/ContactEmail'
        delayMin:
          $ref: '#/components/schemas/NotificationPreferencesAlertDelayMin'
        type:
          $ref: '#/components/schemas/NotificationPreferenceAlertType'
    NotificationPreferencesAlert:
      type: object
      properties:
        id:
          type: integer
          format: int64
        method:
          $ref: '#/components/schemas/NotificationPreferenceAlertMethod'
        contact:
          type: object
          oneOf:
          - $ref: '#/components/schemas/ContactPhoneNumber'
          - $ref: '#/components/schemas/ContactEmail'
        delayMin:
          $ref: '#/components/schemas/NotificationPreferencesAlertDelayMin'
        type:
          $ref: '#/components/schemas/NotificationPreferenceAlertType'
    NotificationPreferenceDutyMethod:
      type: string
      enum:
      - EMAIL
      - SMS
      - PUSH
      - WHATSAPP
      - TELEGRAM
    NotificationPreferencesDutyTypes:
      type: string
      enum:
      - ON_CALL
    NotificationPreferenceSubscriptionMethod:
      type: string
      enum:
      - EMAIL
      - SMS
      - PUSH
    NotificationPreferencesSubscriptionPost:
      type: object
      properties:
        contact:
          type: object
          oneOf:
          - $ref: '#/components/schemas/ContactPhoneNumber'
          - $ref: '#/components/schemas/ContactEmail'
        method:
          $ref: '#/components/schemas/NotificationPreferenceSubscriptionMethod'
    NotificationPreferenceAlertMethod:
      type: string
      enum:
      - EMAIL
      - SMS
      - PUSH
      - VOICE
      - WHATSAPP
      - TELEGRAM
    NotificationPreferencesUpdateType:
      type: string
      enum:
      - ALERT_ACCEPTED
      - ALERT_RESOLVED
      - ALERT_ESCALATED
    NotificationPreferenceUpdateMethod:
      type: string
      enum:
      - EMAIL
      - SMS
      - PUSH
      - WHATSAPP
      - TELEGRAM
    NotificationPreferencesUpdatePost:
      type: object
      properties:
        contact:
          type: object
          oneOf:
          - $ref: '#/components/schemas/ContactPhoneNumber'
          - $ref: '#/components/schemas/ContactEmail'
        method:
          $ref: '#/components/schemas/NotificationPreferenceUpdateMethod'
        type:
          $ref: '#/components/schemas/NotificationPreferencesUpdateType'
    NotificationPreferencesDutyBeforeMin:
      type: integer
      enum:
      - 0
      - 15
      - 30
      - 60
      - 180
      - 360
      - 720
      - 1440
    ContactPhoneNumber:
      type: object
      properties:
        id:
          type: integer
          format: int64
        regionCode:
          type: string
        target:
          type: string
        primary:
          type: boolean
          description: May only be enabled for a single phone number contact at a time
        status:
          $ref: '#/components/schemas/ContactStatus'
  securitySchemes:
    apiKey:
      type: apiKey
      description: The Bearer API key of your user <a href='/api-docs/#section/Authentication'>more info</a>.
      name: Authorization
      in: header
x-original-swagger-version: '2.0'