> ## Documentation Index
> Fetch the complete documentation index at: https://docs.base44.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Get connector connection fields
> This API is in beta. Endpoints, fields, and behavior may still change, so avoid depending on it in production.
Returns the values a connector needs before you [start a connection](/api-reference/start-connector-connection), such as the account subdomain for Snowflake, and the values saved on the app's current connection. Most connectors need none.
Send them as `connection_config` when you start the connection.
This is limited to 150 requests a minute per caller. Some workspaces have a different limit.
This endpoint accepts a personal API key belonging to a user with editor access to the app, including a read-only key. Workspace API keys are not accepted.
## OpenAPI
````yaml /developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/external-auth/connection-config/{integration_type}
openapi: 3.1.0
info:
title: Base44 App Management API
version: 1.0.0
servers:
- url: https://app.base44.com
security:
- PersonalAccessTokenAuth: []
paths:
/api/apps/{app_id}/external-auth/connection-config/{integration_type}:
get:
summary: Get connector connection fields
description: >-
This API is in beta. Endpoints, fields, and behavior may still
change, so avoid depending on it in production.
Returns the values a connector needs before you [start a
connection](/api-reference/start-connector-connection), such as the
account subdomain for Snowflake, and the values saved on the app's
current connection. Most connectors need none.
Send them as `connection_config` when you start the connection.
This is limited to 150 requests a minute per caller. Some workspaces
have a different limit.
This endpoint accepts a personal API key belonging to a user with
editor access to the app, including a read-only key. Workspace API keys
are not accepted.
operationId: >-
get_connection_config_api_apps__app_id__external_auth_connection_config__integration_type__get
parameters:
- name: integration_type
in: path
required: true
schema:
type: string
description: >-
ID of the connector, from `integration_type` in [List
connectors](/api-reference/list-connectors).
title: Integration Type
description: >-
ID of the connector, from `integration_type` in [List
connectors](/api-reference/list-connectors).
example: googlecalendar
- name: app_id
in: path
required: true
schema:
type: string
description: ID of the app.
title: App Id
description: ID of the app.
example: 6820f3a4e7b91d003c45a1f2
responses:
'200':
description: The connector's fields and the app's saved values.
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectionConfigResponse'
'401':
description: Missing or invalid credentials.
'403':
description: >-
You don't have editor access to this app, or you used a workspace
API key.
'404':
description: App not found, or the connector isn't available to you.
'409':
description: The app's workspace requires an unlocked SSO session.
'429':
description: Rate limit reached. Retry later.
components:
schemas:
ConnectionConfigResponse:
properties:
fields:
items:
$ref: '#/components/schemas/ConnectionConfigField'
type: array
title: Fields
description: >-
Values to collect and send as `connection_config`. Empty when the
connector needs none.
example:
- description: The part of your Snowflake URL before .snowflakecomputing.com.
display_name: Snowflake account subdomain
name: subdomain
placeholder: acme-prod
required: true
validation_error: Use letters, digits, and hyphens only.
validation_pattern: ^[a-zA-Z0-9-]+$
connection_config:
additionalProperties:
type: string
type: object
title: Connection Config
description: >-
Values saved on the app's current connection, keyed by field `name`.
Empty when there's no connection.
example:
subdomain: acme-prod
type: object
required:
- fields
- connection_config
title: ConnectionConfigResponse
description: >-
The values a connector needs before authorization, and the app's saved
ones.
ConnectionConfigField:
properties:
name:
type: string
title: Name
description: Key to send the value under in `connection_config`.
example: subdomain
display_name:
type: string
title: Display Name
description: Label for the value.
default: ''
example: Snowflake account subdomain
description:
type: string
title: Description
description: Help text that explains where to find the value.
default: ''
example: The part of your Snowflake URL before .snowflakecomputing.com.
placeholder:
type: string
title: Placeholder
description: Sample value to show in an empty input.
default: ''
example: acme-prod
required:
type: boolean
title: Required
description: >-
Whether the value has to be sent (`true`) or can be left out
(`false`).
default: true
example: true
default_value:
anyOf:
- type: string
- type: 'null'
title: Default Value
description: Value used when the field is left out, or `null` if there is none.
example: login
validation_pattern:
anyOf:
- type: string
- type: 'null'
title: Validation Pattern
description: >-
Regular expression the whole value has to match, or `null` if any
value is accepted.
example: ^[a-zA-Z0-9-]+$
validation_error:
anyOf:
- type: string
- type: 'null'
title: Validation Error
description: >-
Message returned when the value doesn't match `validation_pattern`,
or `null` for the default message.
example: Use letters, digits, and hyphens only.
type: object
required:
- name
title: ConnectionConfigField
description: Schema for a connection configuration field.
securitySchemes:
PersonalAccessTokenAuth:
type: http
scheme: bearer
description: 'Personal access token, sent as `Authorization: Bearer `.'
````