GET

Get supported venues

Returns a list of supported venues with configuration metadata.

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

Response Body

object

venues array of objects required
venues object
- id string required
  
  at least 1 characters
- name string required
  
  at least 1 characters
- description string required
  
  at least 1 characters
- status string enum required
  
  activeinactive
- supportsSubAccounts boolean required
- supportsWhitelisting boolean required
- supportedCredentialAccessLevels array of objects required
  supportedCredentialAccessLevels object
  - accountType string enum required
    
    accountsub_account
  - accessLevels array of objects required
    
    accessLevels object
    
    level string enum required
    
    readwriteread_write
    
    label string required
    
    at least 1 characters
    
    description string required
    
    at least 1 characters
  - connectionCredentials array of objects required
    
    connectionCredentials object
    
    name string required
    
    at least 1 characters
    
    label string required
    
    at least 1 characters
    
    description string required
    
    at least 1 characters
    
    required boolean required
- supportedAccountSubTypes array of objects required
  supportedAccountSubTypes object
  - normalized string required
    
    at least 1 characters
  - displayName string required
    
    at least 1 characters
  - rawType string

400

Bad Request

No response body

401

Unauthorized

Response Body

object

errorName string required
error string required

403

Forbidden

Response Body

object

errorName string required
error string required

500

Internal Server Error

Response Body

object

errorName string required
error string required

curl --request GET \ --url 'https://app.bitgo-test.com/api/link/v1/enterprises/enterpriseId/venues' \ --header 'accept: application/json' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \ --header 'user-id: string'

const url = 'https://app.bitgo-test.com/api/link/v1/enterprises/enterpriseId/venues'; const options = {method: 'GET', headers: {accept: 'application/json', 'Authorization': 'Bearer YOUR_ACCESS_TOKEN', 'user-id': 'string'}}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error(err));

require 'uri' require 'net/http' url = URI("https://app.bitgo-test.com/api/link/v1/enterprises/enterpriseId/venues") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["accept"] = 'application/json' request["Authorization"] = 'Bearer YOUR_ACCESS_TOKEN' request["user-id"] = 'string' response = http.request(request) puts response.read_body

<?php require_once('vendor/autoload.php'); $client = new \GuzzleHttp\Client(); $response = $client->request('GET', 'https://app.bitgo-test.com/api/link/v1/enterprises/enterpriseId/venues', [ 'headers' => [ 'accept' => 'application/json', 'Authorization' => 'Bearer YOUR_ACCESS_TOKEN', 'user-id' => 'string', ], ]); echo $response->getBody();

import requests url = "https://app.bitgo-test.com/api/link/v1/enterprises/enterpriseId/venues" headers = { "accept": "application/json", "Authorization": "Bearer YOUR_ACCESS_TOKEN", "user-id": "string" } response = requests.get(url, headers=headers) print(response.text)

{ "venues": [ { "id": "string", "name": "string", "description": "string", "status": "active", "supportsSubAccounts": true, "supportsWhitelisting": true, "supportedCredentialAccessLevels": [ { "accountType": "account", "accessLevels": [ { "level": "read", "label": "string", "description": "string" } ], "connectionCredentials": [ { "name": "string", "label": "string", "description": "string", "required": true } ] } ], "supportedAccountSubTypes": [ { "normalized": "string", "displayName": "string", "rawType": "string" } ] } ] }