SIsigmacomputing
API connectors

List API connectors

This endpoint returns a paginated list of API connectors. For more information on API connectors, see 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.
get/v2/api-connectors

Request

  • Base URL
    https://api.sigmacomputing.com
  • Auth
    HTTP bearer

Query parameters

pageTokenstring

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

pageSizeinteger

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

orderBystring

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

namestring

Filter results to connectors whose name contains this substring.

Response

The response body.

nextPageTokenstring

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.

Changes

No recorded changes to this operation across all 1 revision of this API.