Ctrl+K

List enterprise video ID users

get/api/v2/admin/enterprise/videoidusers

Query Parameters

  • bitgoOrgstring
    The BitGo org to list video ID users for
    Enum: BitGo Trust BitGo New York BitGo Germany BitGo Switzerland BitGo Europe ApS Frankfurt DE Trust BitGo Singapore BitGo Korea BitGo Custody MENA FZE BitGo India BitGo Sister Trust 1 BitGo Inc
  • statusstringRequired
    The status of the video ID users to list
    Enum: awaitingApproval awaitingAcceptance pendingSchedule pendingInitialId underReview approved rejected archived
  • limitstring<number>
    The maximum number of video ID users to return
  • prevIdstring
    The ID of the video ID user to start listing from
    Min length: >= 1 characters

200 Response

videoIdUsers array[object] required
The list of enterprise video ID users
email string required
The email of the user
Min length: >= 1 characters
userId string required
The user ID
Min length: >= 1 characters
inviter string required
The inviter of the user
Min length: >= 1 characters
state string required
The state of the user
Allowed values: awaitingApproval awaitingAcceptance pendingSchedule pendingInitialId underReview approved rejected archived
videoCallId string
The user's video call ID
approvalDate string
The date the user was approved
archivedDate string
The date the user was archived
pendingApprovalId string
The ID if the user is pending approval
videoLink string
The user's video link
enterpriseId string
EnterpriseId of enterprise this video users belongs to
enterpriseName string
EnterpriseName of enterprise this video users belongs to
nextBatchPrevId string
The ID of the next batch of video ID users

400 Response

name string
Error code
context object required
Properties that apply to a specific error name
error string required
Human-readable error message
requestId string required
Client request id

404 Response

name string
Error code
context object required
Properties that apply to a specific error name
error string required
Human-readable error message
requestId string required
Client request id