---
title: "GET /api/v3/adapter-schema/"
method: GET
path: "/api/v3/adapter-schema/"
tags: ["Adapter Schema"]
---

# GET /api/v3/adapter-schema/

`GET /api/v3/adapter-schema/`

## Request

- Base URL: `https://cloud.getdbt.com`
- URL: `https://cloud.getdbt.com/api/v3/adapter-schema/`
- Auth: HTTP bearer

"
        Fetch the schema for a given adapter. The schema will include details on available fields for connections and credentials.

        Notes:
        - salesforce_v0 is currently in beta and not available to all users.

## Query parameters

- `adapter_version` 'apache_spark_v0' | 'athena_v0' | 'bigquery_v0' | 'bigquery_v1' | 'clickhouse_v0' | 'databricks_spark_v0' | 'databricks_v0' | 'fabric_v0' | 'postgres_v0' | 'redshift_v0' | 'salesforce_v0' | 'snowflake_v0' | 'synapse_v0' | 'teradata_v0' | 'trino_v0', required
- `include_related` string

## Response `200`

- AdapterSchemaResponseEnveloped
  - `data` AdapterSchemaResponse, required
    - `adapter` Adapter
      - `metadata` AdapterMetadata, required
        - `title` string, required: Brief human-facing name for the adapter
        - `docs_link` string, required: Link to the dbt core docs for this adapter
        - `image_link` string, required
        - `private_link` AdapterPrivateLinkProperties
          - `endpoint_type` 'postgres' | 'redshift' | 'snowflake' | 'bigquery' | 'adapter', required: * `postgres` - postgres * `redshift` - redshift * `snowflake` - snowflake * `bigquery` - bigquery * `adapter` - adapter
          - `hostname_field` string: The field in the connection schema that contains the hostname
          - `strip_suffix` string, required: Suffix to be stripped from the private link endpoint to obtain the hostname for the connection
      - `connection` Schema
        - `field_order` string[]: The field order for display in the UI
        - `field_groups` FieldGroup[]: Specification of how certain fields should be grouped
          - `name` string, required
          - `members` string[], required
      - `credential` Schema
        - `field_order` string[]: The field order for display in the UI
        - `field_groups` FieldGroup[]: Specification of how certain fields should be grouped
          - `name` string, required
          - `members` string[], required
      - `platform_metadata_credentials` Schema
        - `field_order` string[]: The field order for display in the UI
        - `field_groups` FieldGroup[]: Specification of how certain fields should be grouped
          - `name` string, required
          - `members` string[], required
      - `analytics_credentials` Schema
        - `field_order` string[]: The field order for display in the UI
        - `field_groups` FieldGroup[]: Specification of how certain fields should be grouped
          - `name` string, required
          - `members` string[], required
      - `semantic_layer_credentials` Schema
        - `field_order` string[]: The field order for display in the UI
        - `field_groups` FieldGroup[]: Specification of how certain fields should be grouped
          - `name` string, required
          - `members` string[], required
      - `cost_insights_config` Schema
        - `field_order` string[]: The field order for display in the UI
        - `field_groups` FieldGroup[]: Specification of how certain fields should be grouped
          - `name` string, required
          - `members` string[], required
  - `status` ResponseStatus, required
    - `code` integer: HTTP status code
    - `is_success` boolean, required: Whether the request was successful or not
    - `user_message` string, required: End-user friendly success or error message
    - `developer_message` string, required: Developer friendly success or error message

## Changes

- **2026-09-29** (v3) `6b5199f1f0c8`: 1 info
  - added the new enum value `clickhouse_v0` to the `query` request parameter `adapter_version`
- **2026-08-10** (v3) `08ccea73f7fa`: 1 info
  - added the optional property `data/adapter/analytics_credentials` to the response with the `200` status
- **2026-08-04** (v3) `26e58ac0a6f6`: 1 info
  - added the optional property `data/adapter/metadata/allOf[#/components/schemas/AdapterMetadata]/private_link` to the response with the `200` status

[Operation history](https://skmtc.dev/getdbt/apis/dbt-cloud-api-v2/changes/api/v3/adapter-schema/get.md)

---

[API](https://skmtc.dev/getdbt/apis/dbt-cloud-api-v2.md) - [All operations](https://skmtc.dev/getdbt/apis/dbt-cloud-api-v2/llms.txt) - [OpenAPI document](https://skmtc.dev/getdbt/apis/dbt-cloud-api-v2/revisions/2448b375ac2f?raw)