---
title: "Describe how an app connects (OAuth vs. key-entry form)"
method: GET
path: "/v1/integrations/connect-fields"
tags: ["integrations"]
---

# Describe how an app connects (OAuth vs. key-entry form)

`GET /v1/integrations/connect-fields`

## Request

- Base URL: `https://api.patricia.app` (the document declares no server; this is the origin it was published from)
- URL: `https://api.patricia.app/v1/integrations/connect-fields`
- Auth: HTTP bearer

Returns whether an app uses the OAuth redirect flow or a credential form. For a non-OAuth app (API key / bearer / basic) it returns the fields the dashboard must collect, so the connect form renders dynamically for whatever the toolkit requires (e.g. an API key + region).

## Query parameters

- `app_slug` string, required: The catalog app slug to describe the connect flow for.

## Headers

- `X-Tenant-Id` string, nullable

## Response `200`

Successful Response

- ConnectFieldsResponse: How an app connects: the OAuth redirect flow, or the fields to collect for a key-entry form.
  - `app_slug` string, required
  - `is_oauth` boolean, required
  - `auth_scheme` string, required
  - `fields` ConnectFieldSchema[]
    - `name` string, required
    - `label` string, required
    - `required` boolean, required
    - `secret` boolean, required
    - `description` string
    - `default` string, nullable
  - `connectable` boolean
  - `unsupported_reason` string, nullable
  - `flow` string
  - `team_only_connect` boolean, required
  - `default_personal` boolean, required
  - `preinstall` AppPreinstall, required: The vendor install one account clears once, before OAuth for that account can complete.
    - `install_url` string, nullable, required
    - `admin_only` boolean
  - `environments` string[]

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/patricia/apis/patricia-api.md) · [All operations](https://skmtc.dev/patricia/apis/patricia-api/llms.txt) · [OpenAPI document](https://skmtc.dev/patricia/apis/patricia-api/revisions/0dfb44495ea1?raw)