Skip to main content
GET
Get integration

Authorizations

Authorization
string
header
required

Use a JWT bearer token or a Veryfront API key in the Authorization header.

Path Parameters

name
string
required

Integration name

Example:

"gmail"

Query Parameters

version
string

Deprecated. The package determines the version.

Response

Integration details

name
string
required
display_name
string
required
icon
string
required
description
string
required
category
string | null
required

Connector category from the veryfront package, such as communication or development. Null when the package declares none.

Example:

"communication"

availability
enum<string>
required

Why this deployment publishes the integration: default (supported everywhere), experimental (enabled by this deployment's experimental integrations setting; may be absent elsewhere) or host_adapter (an adapter-only connector this API drives with its own client).

Available options:
default,
experimental,
host_adapter
Example:

"default"

auth
object
required
credential_env_var_names
string[]
required

Environment variable names for the integration’s credentials. Empty if none are configured.

Example:
credential_requirement
object
required
env_vars
object[]
required
tools
object[]
required
project_connections
object
required
project_user_connections
object
required
icon_url
string<uri>
prompts
object[]
suggested_with
string[]
config_schema
object
setup_guide
object