integrations

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

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).

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

Query parameters

app_slugstring required

The catalog app slug to describe the connect flow for.

Headers

X-Tenant-Idstring nullable

Response

Successful Response

app_slugstring required
is_oauthboolean required
auth_schemestring required
connectableboolean
unsupported_reasonstring nullable
flowstring
team_only_connectboolean required
default_personalboolean required
environmentsstring[]

Changes

No recorded changes to this operation across all 1 revision of this API.