REST APIOrganizationOrganization Management

GET

Retrieve an organization by its ID. The caller must be a member of the organization.

Path Params

  • id string required
    The organization ID

    at least 1 characters

Responses

200
OK

Response Body

object

  • organization object required
    organization object
    • id string required
      The organization ID
    • name string
      The name of the organization
    • pricingPlan string nullable
      The pricing plan for the organization

      ONE OF

      string

    • enterpriseNameSuffix string nullable
      The suffix for the enterprise name

      ONE OF

      string

    • salesforceAccountId string
      The Salesforce account ID
    • enterprises array of strings
    • defaultEnterpriseValues object
      The default values for the enterprise
      defaultEnterpriseValues object
      • bitgoOrg string enum nullable
        BitGo TrustBitGo New YorkBitGo GermanyBitGo SwitzerlandBitGo Europe ApSFrankfurt DE TrustBitGo SingaporeBitGo KoreaBitGo Custody MENA FZEBitGo IndiaBitGo Sister Trust 1BitGo Inc
      • licenses array of string enums
        bitgoNetworkmarginTradingmetaMaskInstitutionalmtGoxportfolioAPIportfolioBasicportfolioProfessionalportfolioInstitutionaltaxtradeAPIstakingstakingApicryptoCompareellipticinstantFeeHotWalletbitgoTrustAsKrsescrowescrowTripartydistributedCustodyWalletselfCustodyLightningWalletcustodyLightningWalletcustodyGoLightningachDebitsadvancedWalletsstablecoinscanBorrowAgainstGoAccountautoLiquidationtradeFixApigoStakinglinkdefiEarnMarketplace
      • labels array of string enums
        B2B2C - SwanB2B2C - BinanceB2B2C - FoldSofiMt GoxBitcoin BuilderEmployeeGeneralB2B2CB2B2B - KeyrailsB2B2B - OnrampB2B2C - OnrampstarterAccountftxbitgoTechnologiesFBOretailfoundationCoinlistSales Referral!Frank Wang
      • usersViewAllWallets boolean nullable
      • videoIdWaived boolean nullable
      • pricingPlan string nullable

        ONE OF

        string

      • upfrontPaymentStatus string nullable

        ONE OF

        string enum

      • accountType string enum nullable
        individualentity
      • pricingType string nullable

        ONE OF

        string enum

      • businessModel string enum nullable
        bitgoAsAServicecryptoAsAServiceParentcryptoAsAServiceChild
      • complianceModel string enum nullable
        EURegulatedEUNonRegulated
      • featureFlags array of string enums
        adaBYOValidatoradaBYODRepadaPledgingadaStakingatomStakingavaxcAlwaysUseHopavaxpStakingavaxpBYOValidatorbscStakingbscBYOValidatorbabylonStakingcronosStakingfetchStakinglidoStakingcosmosBYOValidatoricpStakingnearBYOValidatormaticBYOValidatormpcStakingpstAvaxStakingsolBYOValidatorsomniaStakingsomniaBYOValidatorstoryStakinghypeevmStakinghypeevmBYOValidatorstoryBYOValidatorstAvaxStakingsAvaxStakingv2RewardAccrualReportAPItrxStakingtrxBYOValidatorvetStakingvetBYOValidatorxdcBYOValidatorreactOnlyuseEddsaCommitmentenableBG23enableBG25InstenableBG25RetailbitgoNetworkbtcHSMv3ecdsaTssColdWalletseddsaTssColdWalletsenableMMIethHSMv3nftWalletscheckPendingBalanceOnBuildenableEcdsaWalletsenableTendermintHotWalletsenableMpcEvmCustodyenableMpcEvmHotethBatchStakingenableConcurrentGg18EvmspecialVideoInstructionscsprStakingtssCustodialblockTransactionIfPendingmystenEmployeemystenInvestormonthlyTrustReportsnitroHSMunspentsConsolidationnewPolicyServiceShadowModeuseEnterpriseEcdsaTssChallengeclearingSettlementUIsnowflakeReportsmultiAssetDVPsolStakingAuthorizesuiCustomTxcsprBYOValidatorsuiBYOValidatorstxStakingstxBYOValidatortonBYOValidatorbtcBYOValidatorbtcStakingtonStakinguseEcdsaTssPaillierBlumuseEcdsaTssPhase5allowBackupKeySigninguseCustomValidatorssendTxRequestFullNotificationaddressBookRevisedenableEnterprisePolicybgUILargeEnterpriseenableDurableNonceautomateGoAccountActivationshowUnstableOesPartnersstakingReportscosmosClaimRewardscosmosSwitchValidatorenablePlaidenableMPCv2useWireWithdrawalConfirmAPIdisableDurableNoncetonV1WalletsallowExternalChangeAddressUIeigenStakingeigenBYOValidatoreigenLikeClaimRewardsenableRiskScoringuseValidatorListethRestakingethClaimRewardsenableKycReverificationfetchAdaBalanceFromIndexerpolStakingenableTrxFundingFromGasTankuseAvailableBandwidthForTokenConsolidationenablePreventDuplicateConsolidationsethUnstakingPolicyServicebulkTxeth2StakingnearStakingsolStakingdotStakingmaticStakingsuiStakingwctStakingwflrStakingcoredaoStakingcoredaoBYOValidatorberaStakingberaBYOValidatorberaNativeStakingwalrusStakingwalrusBYOValidatortaoStakingtaoBYOValidatorbabylonBYOValidatorbtcBabylonStakingpolyxStakingpolyxBYOValidatortokenizationglobalTravelRuleaddressReportsenableMarginV2enableMarginV2UImpcV2ReceiveAddressenableUSDSenableDEXenableWalletConnectshouldCreateGoAccountAsynchronouslyenableWhitelistTestTransactionsdisableCustodyGoGasVideoWaiverenableFinancingdisableFinancingfinancingGatedReleaseenableEnterpriseWhitelistenableEnterpriseAddressBookenableSmartContractCallsenableCrossChainRecoveryenablePolicyRuleTemplatesenableUserRoleApprovalActionenableTimeBasedPoliciessecurePolicyWebhooksdontSendStatementEmailNotificationshotBackingWalletsEnabledenableSsoenableOktaSsovolumeTieredTradingFeesenableInternalOnlyTradeProductsshowNewTradeProductsBannerenableTokenManagementTabenableNewConsolidationDesignenableMidnightGlacierDropuseImsBuiltTransactionenableNewInfraredRewardTrackingskipFailedTxnEntriesUpdateexpiryBasedNonceHandlerdisableSelfCustodyWhitelistLockenableTradeV2UIshowOrderBookDataachDebitsEnabledenableFrankfurtDETrustTradingenableEVMKeyringinvoiceFiatFeesseievmStakingseievmBYOValidatorjitoStakingenableKoreanLocalizationtaoBittensorStakingenableDvPBulkInitializationenableUSDMenaaptStakingsolRedelegationBackfillignoreSpendingCalculationMissingMarketDataenableMobileDownloadBannerenableTrxMpcenterpriseLogoUploadcantonByovdisableBridgingenableSignTypedStructuredData
      • distributedCustody object nullable
        distributedCustody object
        • signingBitgoOrg string enum
          BitGo TrustBitGo New YorkBitGo GermanyBitGo SwitzerlandBitGo Europe ApSFrankfurt DE TrustBitGo SingaporeBitGo KoreaBitGo Custody MENA FZEBitGo IndiaBitGo Sister Trust 1BitGo Inc
    • approvedVideoIdUsers array of strings
    • defaultOrgEnterpriseTemplateId string
    • orgFeatureFlags array of string enums
      disableLivenessAsDefaultdontSendStatementEmailNotificationsuserManagementServiceEnabledachDebitsEnabledAllEnterprisesisTriPartyAutoAcceptEnabledtokenManagementServiceEnabledCaaSEnabledFiatPolicieseuRegulated
    • reserveGoAccountId string nullable
      The ID of the organization's reserve holdings Go account
    • licenses array of string enums
      DAppConnectionsKycExemptionFiatWithdrawalConfirmAPI
    • businessModel string enum nullable
      The business model for the organization
      cryptoAsAService
400
Bad Request

Response Body

object

  • name string
    Error code
  • context map of objects required
    Properties that apply to a specific error name
    context object
    • <key> object
  • error string required
    Human-readable error message
  • requestId string required
    Client request id
401
Unauthorized

Response Body

object

  • name string
    Error code
  • context map of objects required
    Properties that apply to a specific error name
    context object
    • <key> object
  • error string required
    Human-readable error message
  • requestId string required
    Client request id
403
Forbidden

Response Body

object

  • name string
    Error code
  • context map of objects required
    Properties that apply to a specific error name
    context object
    • <key> object
  • error string required
    Human-readable error message
  • requestId string required
    Client request id
404
Not Found

Response Body

object

  • name string
    Error code
  • context map of objects required
    Properties that apply to a specific error name
    context object
    • <key> object
  • error string required
    Human-readable error message
  • requestId string required
    Client request id
500
Internal Server Error

Response Body

object

  • name string
    Error code
  • context map of objects required
    Properties that apply to a specific error name
    context object
    • <key> object
  • error string required
    Human-readable error message
  • requestId string required
    Client request id