ORorq-ai
Alerts

List alerts

Changed on

Returns the alerts visible to the caller, newest first. Use starting_after or ending_before to page.

get/v2/alerts

Request

  • Base URL
    https://my.orq.ai
  • URL
    https://my.orq.ai/v2/alerts
  • Auth
    HTTP bearer

Query parameters

limitinteger

Page size, 1-200. Unset uses the server default (25).

starting_afterstring

Cursor for forward pagination. Set to the alert_id of the last item from the previous page.

ending_beforestring

Cursor for backward pagination. Set to the alert_id of the first item from the previous page.

project_idstring

Restrict results to one project.

scope'ALERT_SCOPE_PROJECT' | 'ALERT_SCOPE_WORKSPACE'

Restrict results by ownership boundary. Unspecified returns all alerts visible to the caller; non-admin callers never see workspace alerts.

Response

OK

objectstring required

Object discriminator for list responses; always list.

has_moreboolean required

Whether more alerts are available in the selected pagination direction.

Changes

  • 0b4e519a544fRevision changes
    • info

      added the new optional query request parameter scope

    • info

      added the non-success response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the required property // to the response with the status

  • 732aed62833aRevision changes
    • breaking

      removed the required property // from the response with the status

    • warning

      deleted the query request parameter scope

    • warning

      removed the optional property /////// from the response with the status

    • warning

      removed the optional property /////// from the response with the status

    • info

      removed the non-success response with the status