Skip to main content
GET
/
integrations
/
{name}
Get Integration
curl --request GET \
  --url https://api.veryfront.com/integrations/{name} \
  --header 'Authorization: Bearer <token>'
{
  "name": "<string>",
  "display_name": "<string>",
  "icon": "<string>",
  "description": "<string>",
  "auth": {
    "type": "oauth2",
    "provider": "<string>",
    "authorization_url": "<string>",
    "token_url": "<string>",
    "scopes": [
      "<string>"
    ],
    "callback_path": "<string>",
    "required_apis": [
      {
        "name": "<string>",
        "enable_url": "<string>"
      }
    ]
  },
  "env_vars": [
    {
      "name": "<string>",
      "description": "<string>",
      "required": true,
      "sensitive": true,
      "default": "<string>",
      "docs_url": "<string>"
    }
  ],
  "tools": [
    {
      "id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "requires_write": true
    }
  ],
  "prompts": [
    {
      "id": "<string>",
      "title": "<string>",
      "prompt": "<string>",
      "category": "<string>",
      "icon": "<string>"
    }
  ],
  "suggested_with": [
    "<string>"
  ]
}

Authorizations

Authorization
string
header
required

Authentication via JWT token or API key. JWT: Get from Veryfront dashboard. API Key: Format "vf__" - create via /api-keys endpoint.

Path Parameters

name
string
required

Integration name

Example:

"gmail"

Query Parameters

version
string

Deprecated. Version is now baked into the package.

Response

Integration details

name
string
required
display_name
string
required
icon
string
required
description
string
required
auth
object
required
env_vars
object[]
required
tools
object[]
required
prompts
object[]
suggested_with
string[]