API ReferenceConnected Accounts

Create a new connected account

Markdown
POST
/api/v3/connected_accounts

Initiates a new connection to an external service for a user. For OAuth-based toolkits, this returns a redirect URL to complete authentication. For API key-based toolkits, provide the credentials directly in the request body. Use the user_id field to associate the connection with a specific user in your system.

Authorization

ApiKeyAuth
x-api-key<token>

API key authentication

In: header

Request Body

application/json

auth_config*
connection*
validate_credentials?boolean

[EXPERIMENTAL] Whether to validate the provided credentials, validates only for API Key Auth scheme

Defaultfalse

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://backend.composio.dev/api/v3/connected_accounts" \  -H "Content-Type: application/json" \  -d '{    "auth_config": {      "id": "string"    },    "connection": {}  }'
{
  "id": "string",
  "connectionData": {
    "authScheme": "OAUTH1",
    "val": {
      "subdomain": "string",
      "your-domain": "string",
      "region": "string",
      "shop": "string",
      "account_url": "string",
      "COMPANYDOMAIN": "string",
      "extension": "string",
      "form_api_base_url": "string",
      "instanceEndpoint": "string",
      "api_url": "string",
      "borneo_dashboard_url": "string",
      "proxy_username": "string",
      "proxy_password": "string",
      "domain": "string",
      "version": "string",
      "dc": "string",
      "site_name": "string",
      "instanceName": "string",
      "account_id": "string",
      "your_server": "string",
      "server_location": "string",
      "base_url": "string",
      "status": "INITIALIZING",
      "oauth_token": "string",
      "authUri": "string",
      "oauth_token_secret": "string",
      "redirectUrl": "string",
      "callbackUrl": "string",
      "oauth_verifier": "string",
      "consumer_key": "string",
      "callback_url": "string",
      "error": "string",
      "error_description": "string",
      "expired_at": "string"
    }
  },
  "status": "INITIALIZING",
  "redirect_url": "string",
  "redirect_uri": "string",
  "deprecated": {
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "authConfigUuid": "c21fd4ce-4c63-4ca6-ac55-0aa4b63a9199"
  }
}
{
  "error": {
    "message": "string",
    "code": 0,
    "slug": "string",
    "status": 0,
    "request_id": "string",
    "suggested_fix": "string",
    "errors": [
      "string"
    ]
  }
}
{
  "error": {
    "message": "string",
    "code": 0,
    "slug": "string",
    "status": 0,
    "request_id": "string",
    "suggested_fix": "string",
    "errors": [
      "string"
    ]
  }
}
{
  "error": {
    "message": "string",
    "code": 0,
    "slug": "string",
    "status": 0,
    "request_id": "string",
    "suggested_fix": "string",
    "errors": [
      "string"
    ]
  }
}
{
  "error": {
    "message": "string",
    "code": 0,
    "slug": "string",
    "status": 0,
    "request_id": "string",
    "suggested_fix": "string",
    "errors": [
      "string"
    ]
  }
}
{
  "error": {
    "message": "string",
    "code": 0,
    "slug": "string",
    "status": 0,
    "request_id": "string",
    "suggested_fix": "string",
    "errors": [
      "string"
    ]
  }
}