Ctrl+K

Get notification status

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

Retrieves notification status information for a specific workflow type or transaction ID

Query Parameters

  • 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
  • afterstring
    Filter results created at or after this date/time (inclusive)
  • beforestring
    Filter results created before this date/time (exclusive)
  • 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
    Enum: PENDING QUEUED RUNNING COMPLETED FAILED DELAYED CANCELED MERGED SKIPPED SUCCESS WARNING READ_CONFIRMATION PROCESSING

200 Response

data array[object] required
messageRecordId string <uuid>required
notificationId string <uuid>deprecated
This field is no longer populated and always returns null. It will be removed in a future version.
channel string required
workflowName string required
transactionId string required
status string required
createdAt string <date-time>required
updatedAt string <date-time>required
notificationIdempotencyKey string required
emailDelivery object
metadata object required
total integer <int32>required
page integer <int32>required
limit integer <int32>required
order string required

400 Response

name string required
Error code
Allowed values: ValidationFailed IllegalArgument BadRequest DataIntegrityError NotImplementedError RETRIGGER_RATE_LIMITED USER_CREATION_FAILED USER_FALLBACK_FAILED
error string required
Human-readable error message
status integer <int32>required
HTTP status code
Allowed value: 400

403 Response

name string required
Error code
Allowed value: AccessDenied
error string required
Human-readable error message
status integer <int32>required
HTTP status code
Allowed value: 403

500 Response

name string required
Error code
Allowed values: UnexpectedError ThirdPartyError DatabaseError USER_FALLBACK_TIMEOUT
error string required
Human-readable error message
status integer <int32>required
HTTP status code
Allowed value: 500