---
title: "List API credentials"
method: GET
path: "/v2/api-credentials"
tags: ["API credentials"]
---

# List API credentials

`GET /v2/api-credentials`

## Request

- Base URL: `https://api.sigmacomputing.com`
- URL: `https://api.sigmacomputing.com/v2/api-credentials`
- Auth: HTTP bearer

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.

## Query parameters

- `pageToken` string
- `pageSize` integer
- `orderBy` string
- `name` string

## Response `200`

The response body.

- ApiCredentialsListApiCredentialsResponse200
  - `entries` V2ApiCredentialsGetResponsesContentApplicationJsonSchemaEntriesItems[], required: Array of results returned by the endpoint
    - `apiCredentialId` string, required: Unique identifier of the API credential.
    - `name` string, required: Display name of the credential.
    - `authMethod` 'basic' | 'bearer' | 'apiKey' | 'oAuthClientCredentials' | 'oAuthAuthorizationCode' | 'oAuthPasswordCredentials' | 'awsSigV4', required: Authentication method the credential uses.
    - `allowlist` string[], required: Hostname glob patterns the credential is authorized to be used against.
    - `description` string: Human-readable description.
  - `nextPageToken` string: 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.**

---

[API](https://skmtc.dev/sigmacomputing/apis/sigma-rest-api.md) - [All operations](https://skmtc.dev/sigmacomputing/apis/sigma-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/sigmacomputing/apis/sigma-rest-api/revisions/fb6036208c49?raw)