List connection paths

GET

/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.

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.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Query parameters

pagestringOptional

limitdoubleOptional

connectionIdstringOptional

Response

The response body.

entrieslist of objects

Array of results returned by the endpoint

nextPagestring or null

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.

totaldouble

Total number of results. Useful to determine if there is a need to paginate.

hasMoreboolean

[Deprecated] Indicates whether more results are available.

1	{
2	"entries": [
3	{
4	"connectionId": "conn-9f8b7c6d",
5	"urlId": "url-4a3b2c1d",
6	"path": [
7	"SalesDB",
8	"public"
9	]
10	},
11	{
12	"connectionId": "conn-9f8b7c6d",
13	"urlId": "url-5e6f7a8b",
14	"path": [
15	"SalesDB",
16	"public",
17	"orders"
18	]
19	},
20	{
21	"connectionId": "conn-1a2b3c4d",
22	"urlId": "url-7c8d9e0f",
23	"path": [
24	"MarketingDB"
25	]
26	}
27	],
28	"nextPage": "eyJwYWdlIjoiMjAwIn0=",
29	"total": 45,
30	"hasMore": false
31	}

$	curl https://api.sigmacomputing.com/v2/connections/paths \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json"