Ctrl+K

Get notification status

get/api/notifications/v1/admin/notification-status

Retrieves notification status information by workflow name, transaction ID, idempotency key, or user ID. When querying by userId, both 'after' and 'before' date parameters are required.

Query Parameters

  • requestobjectRequired
    • notificationWorkflowNamestring
      The name of the workflow to retrieve status for
    • transactionIdstring
      Specific transaction ID to retrieve status for
    • notificationIdempotencyKeystring
      Notification idempotency key to retrieve status for
    • userIdstring
      BitGo user ID to retrieve notification records for. Requires 'after' and 'before' date parameters.
    • afterstring
      Filter results to include records created at or after this date/time (inclusive). Supports ISO 8601 datetime (2023-01-01T00:00:00Z) or simple date (2023-01-01).
    • beforestring
      Filter results to include records created before this date/time (exclusive). Supports ISO 8601 datetime (2023-12-31T23:59:59Z) or simple date (2023-12-31).
    • pageinteger<int32>Required
      Page number for pagination (default 1)
      Minimum: >= 1
    • limitinteger<int32>Required
      Number of records per page (default 20, max 100)
      Minimum: >= 1
      Maximum: <= 100
    • orderstringRequired
      Sort order by created_at timestamp (default desc)
      Pattern: ^(asc|desc)$
    • statusstring
      Filter by message status
    • isTransactionIdQuerybooleanRequired
    • isIdempotencyKeyQuerybooleanRequired
    • isUserIdQuerybooleanRequired
    • messageStatusstring
      Enum: PENDING QUEUED RUNNING COMPLETED FAILED DELAYED CANCELED MERGED SKIPPED PROCESSING
    • afterDateTimestring<date-time>
    • beforeDateTimestring<date-time>

200 Response

data array[object] required
messageRecordId string <uuid>required
notificationId string <uuid>
channel string required
transactionId string required
status string required
createdAt string <date-time>required
updatedAt string <date-time>required
notificationIdempotencyKey string required
metadata object required
total integer <int32>required
page integer <int32>required
limit integer <int32>required
order string required