---
title: "List warehouse credentials"
method: GET
path: "/api/v1/org/warehouse-credentials"
tags: ["Organization Warehouse Credentials"]
---

# List warehouse credentials

`GET /api/v1/org/warehouse-credentials`

Get all warehouse credentials for the current organization

## Query parameters

- `summary` boolean

## Response `200`

Ok

- union
  - ApiOrganizationWarehouseCredentialsListResponse
    - `results` OrganizationWarehouseCredentials[], required
      - `credentials` union, required
        - SnowflakeCredentials — From T, pick a set of properties whose keys are in the union K
          - `type` 'snowflake', required
          - `account` string, required
          - `requireUserCredentials` boolean
          - `authenticationType` 'password' | 'private_key' | 'sso' | 'external_browser' | 'oauth_authorization_code' | 'none'
          - `role` string
          - `database` string, required
          - `warehouse` string, required
          - `schema` string, required
          - `threads` number, double
          - `clientSessionKeepAlive` boolean
          - `queryTag` string
          - `accessUrl` string
          - `startOfWeek` 0 | 1 | 2 | 3 | 4 | 5 | 6
          - `dataTimezone` string
          - `quotedIdentifiersIgnoreCase` boolean
          - `disableTimestampConversion` boolean
          - `timeoutSeconds` number, double
          - `override` boolean
          - `organizationWarehouseCredentialsUuid` string
        - RedshiftCredentials — From T, pick a set of properties whose keys are in the union K
          - `type` 'redshift', required
          - `requireUserCredentials` boolean
          - `authenticationType` 'password' | 'iam' | 'iam_browser'
          - `schema` string, required
          - `threads` number, double
          - `startOfWeek` 0 | 1 | 2 | 3 | 4 | 5 | 6
          - `dataTimezone` string
          - `timeoutSeconds` number, double
          - `useSshTunnel` boolean
          - `sshTunnelHost` string
          - `sshTunnelPort` number, double
          - `sshTunnelUser` string
          - `sshTunnelPublicKey` string
          - `host` string, required
          - `port` number, double, required
          - `dbname` string, required
          - `keepalivesIdle` number, double
          - `sslmode` string
          - `ra3Node` boolean
          - `region` string
          - `isServerless` boolean
          - `clusterIdentifier` string
          - `workgroupName` string
          - `autoCreate` boolean
          - `dbGroups` string[]
          - `assumeRoleArn` string
          - `assumeRoleExternalId` string
          - `awsSsoStartUrl` string
          - `awsSsoRegion` string
          - `awsSsoAccountId` string
          - `awsSsoRoleName` string
        - PostgresCredentials — From T, pick a set of properties whose keys are in the union K
          - `type` 'postgres', required
          - `requireUserCredentials` boolean
          - `role` string
          - `schema` string, required
          - `threads` number, double
          - `startOfWeek` 0 | 1 | 2 | 3 | 4 | 5 | 6
          - `dataTimezone` string
          - `timeoutSeconds` number, double
          - `useSshTunnel` boolean
          - `sshTunnelHost` string
          - `sshTunnelPort` number, double
          - `sshTunnelUser` string
          - `sshTunnelPublicKey` string
          - `host` string, required
          - `port` number, double, required
          - `dbname` string, required
          - `keepalivesIdle` number, double
          - `sslmode` string
          - `sslcertFileName` string
          - `sslkeyFileName` string
          - `sslrootcertFileName` string
          - `searchPath` string
        - BigqueryCredentials — From T, pick a set of properties whose keys are in the union K
          - `type` 'bigquery', required
          - `requireUserCredentials` boolean
          - `authenticationType` 'sso' | 'private_key' | 'adc'
          - `threads` number, double
          - `accessUrl` string
          - `startOfWeek` 0 | 1 | 2 | 3 | 4 | 5 | 6
          - `dataTimezone` string
          - `timeoutSeconds` number, double
          - `project` string, required
          - `dataset` string, required
          - `priority` 'interactive' | 'batch'
          - `retries` number, double
          - `location` string
          - `maximumBytesBilled` number, double
          - `executionProject` string
        - DatabricksCredentials — From T, pick a set of properties whose keys are in the union K
          - `type` 'databricks', required
          - `catalog` string
          - `requireUserCredentials` boolean
          - `authenticationType` 'personal_access_token' | 'oauth_m2m' | 'oauth_u2m'
          - `database` string, required
          - `startOfWeek` 0 | 1 | 2 | 3 | 4 | 5 | 6
          - `dataTimezone` string
          - `serverHostName` string, required
          - `httpPath` string, required
          - `compute` object[]
            - `httpPath` string, required
            - `name` string, required
        - TrinoCredentials — From T, pick a set of properties whose keys are in the union K
          - `type` 'trino', required
          - `requireUserCredentials` boolean
          - `schema` string, required
          - `startOfWeek` 0 | 1 | 2 | 3 | 4 | 5 | 6
          - `dataTimezone` string
          - `host` string, required
          - `port` number, double, required
          - `dbname` string, required
          - `http_scheme` string, required
          - `source` string
        - ClickhouseCredentials — From T, pick a set of properties whose keys are in the union K
          - `type` 'clickhouse', required
          - `requireUserCredentials` boolean
          - `schema` string, required
          - `startOfWeek` 0 | 1 | 2 | 3 | 4 | 5 | 6
          - `dataTimezone` string
          - `timeoutSeconds` number, double
          - `host` string, required
          - `port` number, double, required
          - `secure` boolean
        - AthenaCredentials — From T, pick a set of properties whose keys are in the union K
          - `type` 'athena', required
          - `requireUserCredentials` boolean
          - `authenticationType` 'access_key' | 'iam_role'
          - `database` string, required
          - `schema` string, required
          - `threads` number, double
          - `startOfWeek` 0 | 1 | 2 | 3 | 4 | 5 | 6
          - `dataTimezone` string
          - `region` string, required
          - `assumeRoleArn` string
          - `assumeRoleExternalId` string
          - `s3StagingDir` string, required
          - `s3DataDir` string
          - `workGroup` string
          - `numRetries` number, double
        - union
          - DuckdbMotherduckCredentials — From T, pick a set of properties whose keys are in the union K
            - `type` 'duckdb', required
            - `requireUserCredentials` boolean
            - `database` string, required
            - `schema` string, required
            - `threads` number, double
            - `startOfWeek` 0 | 1 | 2 | 3 | 4 | 5 | 6
            - `dataTimezone` string
            - `connectionType` 'motherduck', required
          - DuckdbDucklakeCredentials — From T, pick a set of properties whose keys are in the union K
            - `type` 'duckdb', required
            - `requireUserCredentials` boolean
            - `schema` string, required
            - `threads` number, double
            - `startOfWeek` 0 | 1 | 2 | 3 | 4 | 5 | 6
            - `dataTimezone` string
            - `connectionType` 'ducklake', required
            - `catalogAlias` string
            - `dataPath` union, required
              - …
            - `catalog` union, required
              - …
          - DuckdbEmbeddedCredentials
            - `schema` string
            - `startOfWeek` number, double
            - `dataTimezone` string
            - `requireUserCredentials` boolean
            - `dataset` string, required
            - `connectionType` 'embedded', required
            - `type` 'duckdb', required
      - `createdByUserUuid` string, nullable, required
      - `createdAt` string, date-time, required
      - `warehouseType` 'bigquery' | 'postgres' | 'redshift' | 'snowflake' | 'databricks' | 'trino' | 'clickhouse' | 'athena' | 'duckdb', required
      - `description` string, nullable, required
      - `name` string, required
      - `organizationUuid` string, required
      - `organizationWarehouseCredentialsUuid` string, required
    - `status` 'ok', required
  - ApiOrganizationWarehouseCredentialsSummaryListResponse
    - `results` OrganizationWarehouseCredentialsSummary[], required
      - `name` string, required
      - `description` string, nullable, required
      - `organizationWarehouseCredentialsUuid` string, required
      - `warehouseType` 'bigquery' | 'postgres' | 'redshift' | 'snowflake' | 'databricks' | 'trino' | 'clickhouse' | 'athena' | 'duckdb', required
    - `status` 'ok', required

## Other responses

- `default` — Error

---

[API](https://skmtc.net/lightdash/apis/lightdash-api.md) · [All operations](https://skmtc.net/lightdash/apis/lightdash-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/lightdash/lightdash-api/revisions/40c933755c9a/schema)