Ctrl+K

Get user notification subscriptions (admin)

get/api/notifications/v1/admin/user/{bitgoUserId}/subscriptions

Retrieves the notification subscriptions for a specified user. Admins can optionally filter by communication channel, category name, or notification name to narrow the results. Useful for auditing or managing user notification preferences.

Path Parameters

  • bitgoUserIdstringRequired

Query Parameters

  • channelstring
  • categoryNamestring
  • notificationNamestring

200 Response

notificationSubscriptions array[object] required
id string <uuid>
userId string <uuid>
notificationName string required
categoryName string required
channel string required
isSubscribed boolean required
createdAt string <date-time>required
updatedAt string <date-time>required
isMandatory boolean 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