OAG

OAG Alerts API

The Alerts API from OAG — 2 operation(s) for alerts.

GitHub OpenAPI

Operations 4

GET /alerts Get Alerts #
PATCH /alerts Update Alert #
POST /alerts Create Alert #
DELETE /alerts/{alertid} Delete an Alert on a Client Account #

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/oag/refs/heads/main/openapi/oag-alerts-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/oag/refs/heads/main/json-schema/oag-patch-alerts-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/oag/refs/heads/main/json-schema/oag-patch-flight-info-alerts-alerts-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/oag/refs/heads/main/json-schema/oag-post-alerts-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/oag/refs/heads/main/json-schema/oag-post-flight-info-alerts-flightinfoalertid-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/oag/refs/heads/main/json-schema/oag-get-departuredate-scheduleinstancekey-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/oag/refs/heads/main/json-schema/oag-get-flight-instances-departuredate-scheduleinstancekey-response-schema.json

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/oag:oag-alerts-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

oag-alerts-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: OAG Alerts API
  version: '2026-09-23'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-09-23: 20 operation(s) read from 23 public documentation page(s) (each operation names its page in x-source). This is not the provider''s published contract; OAG has published no machine-readable contract that the pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 0
    documentation: 20
    pages-with-code: 1
    pages-read: 23
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-09-23'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://developers.oag.com/apis/schedules
  - https://developers.oag.com/apis/locations-v1
  - https://developers.oag.com/apis/flight-info-v2
  - https://developers.oag.com/apis/flight-info-alerts-v1
  - https://developers.oag.com/apis/flight-info-v2/GetFlight
  - https://developers.oag.com/apis/flight-info-v2/GetFlights
  - https://developers.oag.com/apis/locations-v1/GetLocations
  - https://developers.oag.com/apis/flight-info-connections-v1
  - https://developers.oag.com/apis/flight-info-alerts-v1/status
  - https://developers.oag.com/apis/schedules/GetActiveSchedules
  - https://developers.oag.com/apis/flight-info-alerts-v1/getAlert
  - https://developers.oag.com/apis/flight-info-alerts-v1/getAlerts
  - https://developers.oag.com/apis/flight-info-alerts-v1/createAlert
  - https://developers.oag.com/apis/flight-info-alerts-v1/deleteAlert
  - https://developers.oag.com/apis/flight-info-alerts-v1/updateAlert
  - https://developers.oag.com/apis/schedules/schedules-iata-carriers
  - https://developers.oag.com/apis/schedules/schedules-icao-carriers
  - https://developers.oag.com/apis/flight-info-alerts-v1/getAccessKey
  - https://developers.oag.com/apis/flight-info-alerts-v1/updateProfile
  - https://developers.oag.com/apis/flight-info-alerts-v1/completeProfile
  - https://developers.oag.com/apis/flight-info-connections-v1/Connections
  - https://developers.oag.com/apis/flight-info-alerts-v1/getAccountProfile
  - https://developers.oag.com
servers:
- url: https://api.oag.com
tags:
- name: Alerts
paths:
  /alerts:
    get:
      operationId: get_alerts
      tags:
      - Alerts
      summary: Get Alerts
      description: Retrieves the list of alert configurations in the customer profile by the provided account id.
      x-source: https://developers.oag.com/apis/flight-info-alerts-v1/getAlerts
      parameters:
      - name: accountId
        in: header
        required: true
        schema:
          type: string
      - name: version
        in: query
        required: false
        schema:
          type: string
        description: API version, e.g., v1
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAlertsResponse'
      x-evidence:
        kind: documentation
    patch:
      operationId: patch_alerts
      tags:
      - Alerts
      summary: Update Alert
      x-source: https://developers.oag.com/apis/flight-info-alerts-v1/updateAlert
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchAlertsRequest'
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PatchAlertsResponse'
      x-evidence:
        kind: documentation
    post:
      operationId: post_alerts
      tags:
      - Alerts
      summary: Create Alert
      x-source: https://developers.oag.com/apis/flight-info-alerts-v1/createAlert
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostAlertsRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostAlertsResponse'
      x-evidence:
        kind: documentation
  /alerts/{alertid}:
    delete:
      operationId: delete_alerts_alertid
      tags:
      - Alerts
      summary: Delete an Alert on a Client Account
      description: Delete an Alert on a Client Account.
      x-source: https://developers.oag.com/apis/flight-info-alerts-v1/deleteAlert
      parameters:
      - name: alertid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteAlertsAlertidResponse'
      x-evidence:
        kind: documentation
components:
  schemas:
    DeleteAlertsAlertidResponse:
      type: object
      properties:
        '200':
          type: string
          description: OK
        '404':
          type: string
          description: Not Found
        '406':
          type: string
          description: Not Acceptable
        '422':
          type: string
          description: Unprocessable Entity
        '500':
          type: string
          description: Internal Server Error
    PatchAlertsRequest:
      type: object
      properties:
        alertId:
          type: string
          description: Alphanumeric characters generated on the creation of the alert.
        name:
          type: string
          description: Some text assigning a name to the alert.
        description:
          type: string
          description: Some text describing the purpose of the alert.
        iataCarrierCode:
          type: string
          description: A two-character code assigned by the IATA to international airlines. Optional unless updating an alert to alertType "Carrier", in which case iataCarrierCode and/or icaoCarrierCode must be supplied.
        icaoCarrierCode:
          type: string
          description: A three-character code assigned by the ICAO to international airlines. Optional unless updating an alert to alertType "Carrier", in which case iataCarrierCode and/or icaoCarrierCode must be supplied.
        flightNumber:
          type: integer
          description: A numeric part (up to four digits) of a flight designator.
        fromFlight:
          type: integer
          description: A numeric part (up to four digits) of a flight designator.
        toFlight:
          type: integer
          description: A numeric part (up to four digits) of a flight designator.
        departureAirport:
          type: string
          description: A Three-letter code assigned by the IATA to an airport location representing the departure airport. Optional unless updating an alert to alertType "Port", in which case departureAirport and/or arrivalAirport must be supplied.
        arrivalAirport:
          type: string
          description: A Three-letter code assigned by the IATA to an airport location representing the arrival airport. Optional unless creating an alert to alertType "Port", in which case departureAirport and/or arrivalAirport must be supplied.
        alertType:
          type: string
          description: The type of alert being configured. Accepted values are "Global", "Carrier" or "Port".
        active:
          type: boolean
          description: A true/false value to enable/disable the alert.
        content:
          type: string
          description: If the string "seats, changeindicator" is specified, seat and change indicator data will be included in the alert output.
        departureDate:
          type: string
          description: A date in the format yyyy-MM-dd for flight departures.
        arrivalDate:
          type: string
          description: A date in the format yyyy-MM-dd for flight arrivals.
        schedules:
          type: boolean
          description: A true/false value to enable/disable the inclusion of schedules flight updates in the event feed.
        status:
          type: boolean
          description: A true/false value to enable/disable the inclusion of status flight updates in the event feed.
        gaFlights:
          type: boolean
          description: A true/false value to enable/disable the inclusion of GA flight updates in the event feed.
        unscheduledFlights:
          type: boolean
          description: A true/false value to enable/disable the inclusion of unscheduled flight updates in the event feed.
        codeshare:
          type: boolean
          description: A true/false value to enable/disable the inclusion of marketing flight updates in the event feed. Defaults to true.
        estimatedArrivalTimeThreshold:
          type: integer
          description: Positive or negative threshold for estimated arrival time.
        estimatedDepartureTimeThreshold:
          type: integer
          description: Positive or negative threshold for estimated departure time.
        statusChangeFilters:
          type: object
          description: Filters for specific status changes.
        statusChangeFilters.baggage:
          type: boolean
          description: If value is "false", will ignore flight updates that only have a change in baggage.
        statusChangeFilters.aircraftRegistrationNumber:
          type: boolean
          description: If value is "false", will ignore flight updates that only have a change in aircraftRegistrationNumber.
        statusChangeFilters.gates:
          type: boolean
          description: If value is "false", will ignore flight updates that only have a change in gates.
        statusChangeFilters.terminal:
          type: boolean
          description: If value is "false", will ignore flight updates that only have a change in terminal.
        statusChangeFilters.seats:
          type: boolean
          description: If value is "false", will ignore flight updates that only have a change in seats.
        statusChangeFilters.aircraftType:
          type: boolean
          description: If value is "false", will ignore flight updates that only have a change in aircraftType.
      required:
      - alertId
    PostAlertsRequest:
      type: object
      properties:
        accountId:
          type: string
          description: Alphanumeric characters generated on the creation of the customer profile.
        name:
          type: string
          description: Some text assigning a name to the alert.
        description:
          type: string
          description: Some text describing the purpose of the alert.
        iataCarrierCode:
          type: string
          description: A two-character code assigned by the IATA to international airlines. Optional unless creating an alert with alertType "Carrier", in which case iataCarrierCode and/or icaoCarrierCode must be supplied.
        icaoCarrierCode:
          type: string
          description: A three-character code assigned by the ICAO to international airlines. Optional unless creating an alert with alertType "Carrier", in which case iataCarrierCode and/or icaoCarrierCode must be supplied.
        flightNumber:
          type: integer
          description: A numeric part (up to four digits) of a flight designator.
        fromFlight:
          type: integer
          description: A numeric part (up to four digits) of a flight designator.
        toFlight:
          type: integer
          description: A numeric part (up to four digits) of a flight designator.
        departureAirport:
          type: string
          description: A Three-letter code assigned by the IATA to an airport location representing the departure airport. Optional unless creating an alert with alertType "Port", in which case departureAirport and/or arrivalAirport must be supplied.
        arrivalAirport:
          type: string
          description: A Three-letter code assigned by the IATA to an airport location representing the arrival airport. Optional unless creating an alert with alertType "Port", in which case departureAirport and/or arrivalAirport must be supplied.
        alertType:
          type: string
          description: The type of alert being configured. Accepted values are "Global", "Carrier" or "Port".
        content:
          type: string
          description: If the string "seats, changeindicator" is specified, seat and change indicator data will be included in the alert output.
        departureDate:
          type: string
          description: A date in the format yyyy-MM-dd for flight departures.
        arrivalDate:
          type: string
          description: A date in the format yyyy-MM-dd for flight arrivals.
        schedules:
          type: boolean
          description: A true/false value to enable/disable the inclusion of schedules flight updates in the event feed. Defaults to true if you are allowed to use schedules alerts.
        status:
          type: boolean
          description: A true/false value to enable/disable the inclusion of status flight updates in the event feed. Defaults to true if you are allowed to use status alerts.
        gaFlights:
          type: boolean
          description: A true/false value to enable/disable the inclusion of GA flight updates in the event feed. Defaults to false.
        unscheduledFlights:
          type: boolean
          description: A true/false value to enable/disable the inclusion of unscheduled flight updates in the event feed. Defaults to false.
        codeshare:
          type: boolean
          description: A true/false value to enable/disable the inclusion of marketing flight updates in the event feed. Defaults to true.
        estimatedArrivalTimeThreshold:
          type: integer
          description: An integer value +- 1440 minutes. When set a filter match threshold is set to match flights arriving before or after the set threshold. A negative threshold will match flights arriving at or before the ETA time and positive integer will match flights arriving at or after the ETA time. Change Indicator filters take a higher priority to this filter.
        estimatedDepartureTimeThreshold:
          type: integer
          description: An integer value +- 1440 minutes. When set a filter match threshold is set to match flights departing before or after the set threshold. A negative threshold will matchcd flights departing at or before the ETD time and positive integer will match flights departing at or after the ETD time. Change Indicator filters take a higher priority to this filter.
        statusChangeFilters:
          type: object
          description: Object containing boolean flags for specific change filters.
      required:
      - accountId
      - alertType
    PatchAlertsResponse:
      type: object
      properties:
        '200':
          type: string
          description: OK – successful update of alert configuration.
        '404':
          type: string
          description: Not Found – alert does not exist.
        '406':
          type: string
          description: Not Acceptable – request format not acceptable.
        '422':
          type: string
          description: Unprocessable Entity – validation errors.
        '500':
          type: string
          description: Internal Server Error – unexpected server error.
    GetAlertsResponse:
      type: object
      properties:
        '200':
          type: string
          description: OK – list of alert configurations returned as an array of objects with the fields defined in AlertParameter.
        '404':
          type: string
          description: Not Found – error object with timestamp, status, message, detail, subErrors.
        '406':
          type: string
          description: Not Acceptable – error object with timestamp, status, message, detail, subErrors.
        '422':
          type: string
          description: Unprocessable Entity – error object with timestamp, status, message, detail, subErrors.
        '500':
          type: string
          description: Internal Server Error – error object with timestamp, status, message, detail, subErrors.
    PostAlertsResponse:
      type: object
      properties:
        '201':
          type: string
          description: Created – successful creation of alert.
        '400':
          type: string
          description: Bad Request – validation errors.
        '404':
          type: string
          description: Not Found – resource not found.
        '406':
          type: string
          description: Not Acceptable – request not acceptable.
        '422':
          type: string
          description: Unprocessable Entity – semantic errors.
        '500':
          type: string
          description: Internal Server Error – server side failure.