Sigma REST APIAPI connectors

List API connectors

View as Markdown
This endpoint returns a paginated list of API connectors. For more information on API connectors, see [Configure API credentials and connectors in Sigma](https://help.sigmacomputing.com/docs/configure-api-credentials-and-connectors-in-sigma). ### Usage notes - Only returns API connectors that the user making this request has at least **Can view** access to. - Use the `name` query parameter to filter by connector name. - Use the `orderBy` query parameter to set sort order. ### Usage scenarios - **Connector discovery:** Retrieve a list of available API connectors available to users configuring **Call API** actions. - **Connector management:** View and audit the organization's API connectors.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Query parameters

pageTokenstringOptional

Use to specify the next set of results with the string returned in the nextPageToken field of the previous response.

pageSizeintegerOptional
Number of results to return per page, with a maximum of 1000. Defaults to 50.
orderBystringOptional

Sort order. Supported fields: name, description. Append desc for descending (e.g. name desc). Defaults to name ascending.

namestringOptional
Filter results to connectors whose name contains this substring.

Response

The response body.
entrieslist of objects
Array of results returned by the endpoint
nextPageTokenstringOptional

A string that can be passed to the pageToken parameter in the next request to fetch the next page of results. Not present in the last page of results. Must be treated as an opaque string.