> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://help.sigmacomputing.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://help.sigmacomputing.com/_mcp/server. # List connection paths GET https://api.sigmacomputing.com/v2/connections/paths List all paths for all connections available to the user. ### Usage notes - Call this endpoint to retrieve the specific databases, catalogs, schemas, and tables available to the user associated with the API credentials. - Pass `connectionId` to restrict results to a single connection. Reference: https://help.sigmacomputing.com/reference/list-connection-paths ## OpenAPI Specification ```yaml openapi: 3.1.0 info: title: sigma-rest-api version: 1.0.0 paths: /v2/connections/paths: get: operationId: listConnectionPaths summary: List connection paths description: |- List all paths for all connections available to the user. ### Usage notes - Call this endpoint to retrieve the specific databases, catalogs, schemas, and tables available to the user associated with the API credentials. - Pass `connectionId` to restrict results to a single connection. tags: - Connections parameters: - name: page in: query required: false schema: type: string - name: limit in: query required: false schema: type: number format: double - name: connectionId in: query required: false schema: type: string - name: Authorization in: header description: OAuth authentication required: true schema: type: string responses: '200': description: The response body. content: application/json: schema: $ref: >- #/components/schemas/connections_listConnectionPaths_Response_200 servers: - url: https://api.sigmacomputing.com description: Server for GCP (US) hosted organizations - url: https://api.sa.gcp.sigmacomputing.com description: Server for GCP (KSA) hosted organizations - url: https://aws-api.sigmacomputing.com description: Server for AWS US (West) hosted organizations - url: https://api.us-a.aws.sigmacomputing.com description: Server for AWS US (East) hosted organizations - url: https://api.ca.aws.sigmacomputing.com description: Server for AWS Canada hosted organizations - url: https://api.eu.aws.sigmacomputing.com description: Server for AWS Europe hosted organizations - url: https://api.au.aws.sigmacomputing.com description: Server for AWS Australia and APAC hosted organizations - url: https://api.uk.aws.sigmacomputing.com description: Server for AWS UK hosted organizations - url: https://api.us.azure.sigmacomputing.com description: Server for Azure US hosted organizations - url: https://api.eu.azure.sigmacomputing.com description: Server for Azure Europe hosted organizations - url: https://api.ca.azure.sigmacomputing.com description: Server for Azure Canada hosted organizations - url: https://api.uk.azure.sigmacomputing.com description: Server for Azure United Kingdom hosted organizations - url: https://api.au.azure.sigmacomputing.com description: Server for Azure Australia hosted organizations components: schemas: V2ConnectionsPathsGetResponsesContentApplicationJsonSchemaEntriesItemsPath: oneOf: - type: array items: type: string - type: array items: type: string - type: array items: type: string - type: array items: description: Any type title: >- V2ConnectionsPathsGetResponsesContentApplicationJsonSchemaEntriesItemsPath V2ConnectionsPathsGetResponsesContentApplicationJsonSchemaEntriesItems: type: object properties: connectionId: type: string urlId: type: string path: $ref: >- #/components/schemas/V2ConnectionsPathsGetResponsesContentApplicationJsonSchemaEntriesItemsPath required: - connectionId - urlId - path title: V2ConnectionsPathsGetResponsesContentApplicationJsonSchemaEntriesItems connections_listConnectionPaths_Response_200: type: object properties: entries: type: array items: $ref: >- #/components/schemas/V2ConnectionsPathsGetResponsesContentApplicationJsonSchemaEntriesItems description: Array of results returned by the endpoint nextPage: type: - string - 'null' description: >- Returns a string that can be used as the `page` parameter in the next request to fetch the next page of results. The last page of results returns `null`. total: type: number format: double description: >- Total number of results. Useful to determine if there is a need to paginate. hasMore: type: boolean description: '**[Deprecated]** Indicates whether more results are available.' required: - entries - nextPage title: connections_listConnectionPaths_Response_200 securitySchemes: OAuth: type: http scheme: bearer description: OAuth 2.0 authentication ``` ## Examples **Request** ```json {} ``` **Response** ```json { "entries": [ { "connectionId": "conn-9f8b7c6d", "urlId": "url-4a3b2c1d", "path": [ "SalesDB", "public" ] }, { "connectionId": "conn-9f8b7c6d", "urlId": "url-5e6f7a8b", "path": [ "SalesDB", "public", "orders" ] }, { "connectionId": "conn-1a2b3c4d", "urlId": "url-7c8d9e0f", "path": [ "MarketingDB" ] } ], "nextPage": "eyJwYWdlIjoiMjAwIn0=", "total": 45, "hasMore": false } ``` **SDK Code** ```python import requests url = "https://api.sigmacomputing.com/v2/connections/paths" payload = {} headers = { "Authorization": ".", "Content-Type": "application/json" } response = requests.get(url, json=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://api.sigmacomputing.com/v2/connections/paths'; const options = { method: 'GET', headers: {Authorization: '.', 'Content-Type': 'application/json'}, body: '{}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://api.sigmacomputing.com/v2/connections/paths" payload := strings.NewReader("{}") req, _ := http.NewRequest("GET", url, payload) req.Header.Add("Authorization", ".") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://api.sigmacomputing.com/v2/connections/paths") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["Authorization"] = '.' request["Content-Type"] = 'application/json' request.body = "{}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://api.sigmacomputing.com/v2/connections/paths") .header("Authorization", ".") .header("Content-Type", "application/json") .body("{}") .asString(); ``` ```php request('GET', 'https://api.sigmacomputing.com/v2/connections/paths', [ 'body' => '{}', 'headers' => [ 'Authorization' => '.', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.sigmacomputing.com/v2/connections/paths"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "."); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "Authorization": ".", "Content-Type": "application/json" ] let parameters = [] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://api.sigmacomputing.com/v2/connections/paths")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```