---
title: "Retrieve notification runs"
method: GET
path: "/api/v1/notifications/logs/run"
tags: ["Notification Logs"]
---

# Retrieve notification runs

`GET /api/v1/notifications/logs/run`

## Request

- Base URL: `https://api.getcortexapp.com`
- URL: `https://api.getcortexapp.com/api/v1/notifications/logs/run`
- Auth: HTTP bearer

Retrieve notification runs based on the provided filters. API key must have the `View Notification logs` permission.

## Query parameters

- `notificationTypes` string[]
- `statuses` string[]
- `mediums` string[]
- `ignoredReasons` string[]
- `failedReasons` string[]
- `includeObjects` boolean
- `fromDate` string, date-time
- `untilDate` string, date-time
- `deliveredOnly` boolean
- `pageSize` integer, required
- `page` integer, required
- `orderBy` 'ASC' | 'DESC'

## Response `200`

Successfully retrieved notification runs

- NotificationRunResponse
  - `page` integer, required: Current page number, 0-indexed
  - `runs` NotificationRun[], required
    - `dateCreated` string, date-time: The date and time that this notification run was created.
    - `dateUpdated` string, date-time: The date and time that this notification run was updated.
    - `deliveredCount` integer, required: The number of notifications that were delivered during this run.
    - `errorMessage` string: An additional error message.
    - `failedReason` 'PACKET_GENERATOR_ERROR' | 'CONTEXT_RESOLUTION_ERROR' | 'INTERNAL_ERROR': The reason why this notification run failed.
    - `id` integer, required: The unique identifier of the notification run.
    - `ignoredReason` 'SCORECARD_DISABLED' | 'WORKSPACE_DISABLED' | 'NO_RECIPIENTS': The reason why this notification run was ignored.
    - `medium` 'SLACK' | 'MICROSOFT_TEAMS' | 'EMAIL' | 'WEBHOOK', required: The medium used to send the notifications.
    - `notificationObjects` NotificationObject[]: The objects (Entities, Scorecards and Initiatives) associated with this run.
      - `cid` string: Unique, immutable, 18-character auto-generated identifier. Applicable only for entities.
      - `id` integer, required: The unique internal identifier of the notification object.
      - `name` string, required: The name of the notification object.
      - `tag` string: Unique identifier, found in the UI. Applicable for entities and scorecards.
      - `type` 'ENTITY' | 'SCORECARD' | 'INITIATIVE', required: The type of the notification object.
      - `url` string: The URL of the notification object's home page in Cortex.
    - `notificationType` 'INITIATIVE_CREATION' | 'INITIATIVE_CUSTOM_SCHEDULE' | 'INITIATIVE_N_DAYS_LEFT' | 'SERVICE_REEVALUATED' | 'WEEKLY_REPORT' | 'BROKEN_OPEN_API_SPEC' | 'ENTITLEMENT_EXPIRATION' | 'ONCALL_ASSISTANT' | 'ONBOARDING_MESSAGE' | 'NOTIFY_INVALID_INTEGRATION' | 'ONCALL_PERSON_CHANGED' | 'ONCALL_STARTS_IN_N_DAYS' | 'TEAM_MEMBER_INVITATION' | 'PENDING_RULE_EXEMPTION' | 'TOKEN_EXPIRES_IN_N_DAYS' | 'SCHEDULED_SCORECARD_RULE_CREATION' | 'SCORECARD_RULE_ACTIVATES_IN_N_DAYS' | 'WORKFLOW_STATUS_UPDATE' | 'WORKFLOW_APPROVAL_PENDING' | 'VERIFICATION_PERIOD_STARTED' | 'VERIFICATION_PERIOD_REMINDER' | 'AI_ASSISTANT_WELCOME_MESSAGE' | 'ENTITY_SCORE_DROPPED' | 'ONBOARDING_WIZARD_STATE_COMPLETED' | 'EXPORT_COMPLETED' | 'OPEX_COMMENT_MENTION' | 'OPEX_COMMENT_THREAD_ACTIVITY', required: The type of the notification
    - `originalRunId` integer: The unique identifier of the original run that this run was re-run from.
    - `seqNo` integer, required: The order of the run in the sequence of re-runs. 0 if it's the original run.
    - `status` 'CREATED' | 'FAILED' | 'IGNORED' | 'COMPLETED' | 'COMPLETED_WITH_ERRORS', required: The status of the notification run.
    - `summary` string, required: The summary of the notification run.
  - `total` integer, required: Total number of results
  - `totalPages` integer, required: Total number of pages

## Other responses

- `403`: Forbidden
- `429`: The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.

## Changes

- **2026-11-03** `a7b058663c95`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/cortex/apis/cortex-api/changes/api/v1/notifications/logs/run/get.md)

---

[API](https://skmtc.dev/cortex/apis/cortex-api.md) - [All operations](https://skmtc.dev/cortex/apis/cortex-api/llms.txt) - [OpenAPI document](https://skmtc.dev/cortex/apis/cortex-api/revisions/a7b058663c95?raw)
