REST API›Link›Link Permissions

GET

Get enterprise member Link access

Returns every UMS member of the enterprise that holds at least one Link permission (link.account.admin, link.account.transfer, or link.account.view), regardless of which role granted it, together with one access grant per Link permission held and the enterprise's total Link account count. Unpaginated. Requires the caller to be an organization admin; bitgo.link.admin alone does not grant access.

Path Params

  • enterpriseId string required
    Your enterprise id.

    at least 1 characters · matches ^[0-9a-f]{32}$

Header Params

  • user-id string required
    User id of the user making the request.

    at least 1 characters

Responses

200
OK

Response Body

object

All Link members of one enterprise with their per-permission Link access, plus the enterprise's total Link account count so consumers can render summaries like "All Linked accounts (N)". Unpaginated: the member list defines the consumer's row set, so it is always returned in full.
  • members array of objects required
    members object
    • userId string required
      The member's external (BitGo) user ID.

      at least 1 characters

    • linkAccess array of objects required

      ONE OF

      • permission string enum required
        link.account.adminlink.account.transferlink.account.view
      • scope string enum required
        ALL
  • totalLinkAccounts number required
    Total number of non-deleted Link accounts in the enterprise.
400
Bad Request
No response body
401
Unauthorized

Response Body

object

Standard structured error response payload for Link API v1 error responses. Contains an error name and human-readable error message.
  • errorName string required
  • error string required
403
Forbidden

Response Body

object

Standard structured error response payload for Link API v1 error responses. Contains an error name and human-readable error message.
  • errorName string required
  • error string required
404
Not Found

Response Body

object

Standard structured error response payload for Link API v1 error responses. Contains an error name and human-readable error message.
  • errorName string required
  • error string required
500
Internal Server Error

Response Body

object

Standard structured error response payload for Link API v1 error responses. Contains an error name and human-readable error message.
  • errorName string required
  • error string required