List API credentials

GET

/v2/api-credentials

GET

/v2/api-credentials

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

200Retrieved

1 {
2   "entries": [
3     {
4       "apiCredentialId": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
5       "name": "Salesforce API Credential",
6       "authMethod": "oAuthClientCredentials",
7       "allowlist": [
8         "*.salesforce.com",
9         "api.partner.salesforce.com"
10       ],
11       "description": "OAuth client credentials for Salesforce integration"
12     },
13     {
14       "apiCredentialId": "f0e1d2c3-b4a5-6789-0abc-def123456789",
15       "name": "Internal Service Key",
16       "authMethod": "apiKey",
17       "allowlist": [
18         "internal.company.com"
19       ],
20       "description": "API key for internal microservice access"
21     }
22   ],
23   "nextPageToken": "eyJwYWdlIjoyfQ=="
24 }

This endpoint returns a paginated list of API credentials. For more information on API credentials, see Configure API credentials and connectors in Sigma.

Usage notes

The user making this request must be assigned an account type with the Manage API connectors permission enabled.
Only returns API credentials that the user making this request has at least Can view access to.
Secret fields such as passwords, tokens, and client secrets are never included in the response.
Use the name query parameter to filter by credential name.
Use the orderBy query parameter to set sort order.

Usage scenarios

Credential management: View and audit the credentials used by API connectors in your Sigma organization.
API connector creation: Retrieve available credentials to present as options when creating an API connector.

This endpoint returns a paginated list of API credentials. For more information on API credentials, see [Configure API credentials and connectors in Sigma](https://help.sigmacomputing.com/docs/configure-api-credentials-and-connectors-in-sigma). ### Usage notes - The user making this request must be assigned an account type with the **Manage API connectors** permission enabled. - Only returns [API credentials](https://help.sigmacomputing.com/docs/configure-api-credentials-and-connectors-in-sigma#add-a-new-api-credential-to-sigma) that the user making this request has at least **Can view** access to. - Secret fields such as passwords, tokens, and client secrets are never included in the response. - Use the `name` query parameter to filter by credential name. - Use the `orderBy` query parameter to set sort order. ### Usage scenarios - **Credential management:** View and audit the credentials used by API connectors in your Sigma organization. - **API connector creation:** Retrieve available credentials to present as options when creating an API connector.

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.