GEgetkard
notifications > Notifications

List Notifications

Changed on

Lists notifications previously dispatched to the issuer, most recent first.

Results are filterable by event name, delivery status, and a created_at time range.<br/> <b>Required scopes:</b> notifications:read

get/v2/issuers/{organizationId}/notifications

Request

  • Base URL
    https://rewards-api.getkard.com
  • URL
    https://rewards-api.getkard.com/v2/issuers/{organizationId}/notifications
  • Auth
    HTTP bearer

Path parameters

organizationIdstring required

Your issuer organization ID, provided by Kard

Query parameters

page[after]string

Represents a cursor value, and if provided, returns the next page of results

page[before]string

Represents a cursor value, and if provided, returns the previous page of results

page[size]integer

Maximum number of records to be returned [1 - 200], (default = 200)

filter[eventName]'earnedRewardApproved' | 'earnedRewardSettled' | 'earnedRewardRejected' | 'auditUpdate' | 'fileProcessingResult' | 'pushNotificationPlacementFile' | 'emailNotificationPlacementFile' | 'payoutReconciliationFile'

Return only notifications for this event name.

filter[status]'pending' | 'delivered' | 'delivery_failed'

The delivery status of a notification.

Return only notifications with this delivery status.

filter[after]string date-time

Return only notifications created strictly after this timestamp (ISO 8601).

filter[before]string date-time

Return only notifications created strictly before this timestamp (ISO 8601).

Response

Response with status 200

Changes

  • 4e87fc8b018bRevision changes
    • info

      added the non-success response with the status

  • a664c5d23771Revision changes
    • warning

      added the new payoutReconciliationFile enum value to the //// response property for the response status

    • info

      added the new enum value payoutReconciliationFile to the query request parameter filter[eventName]