List API connectors

GET

/v2/api-connectors

GET

/v2/api-connectors

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

200Retrieved

1 {
2   "entries": [
3     {
4       "apiConnectorId": "acb12345-6789-4def-9012-abcdef345678",
5       "name": "Salesforce Connector",
6       "description": "Connector for accessing Salesforce CRM data via REST API"
7     },
8     {
9       "apiConnectorId": "dfe98765-4321-4abc-9876-fedcba654321",
10       "name": "Google Analytics API",
11       "description": "Connector to retrieve Google Analytics reporting data"
12     },
13     {
14       "apiConnectorId": "7890abcd-1234-4efg-5678-hijklmn901234",
15       "name": "Zendesk Support API",
16       "description": "Connector for Zendesk ticketing system API integration"
17     }
18   ],
19   "nextPageToken": "eyJwYWdlIjoxfQ=="
20 }

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.

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

pageSizeintegerOptional

orderBystringOptional

namestringOptional

Response

The response body.

entrieslist of objects

Array of results returned by the endpoint

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.