Sigma REST APIConnectionspaths

List connection paths

View as Markdown
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
Use to specify further pages using the string returned in the nextPage portion of the response.
limitdoubleOptional

Number of results to return per page, with a maximum of 1,000 per request. Use the page option in subsequent requests to retrieve the next set of results.

connectionIdstringOptional
Restrict results to paths within this connection.

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.

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

[Deprecated] Indicates whether more results are available.