Create a new connected account

1 import requests 2 3 url = "https://backend.composio.dev/api/v3/connected_accounts" 4 5 payload = { "auth_config": { "id": "string" } } 6 headers = { 7 "x-api-key": "<apiKey>", 8 "Content-Type": "application/json" 9 } 10 11 response = requests.post(url, json=payload, headers=headers) 12 13 print(response.json())

1 { 2 "id": "string", 3 "connectionData": { 4 "authScheme": "OAUTH1", 5 "val": { 6 "subdomain": "string", 7 "your-domain": "string", 8 "region": "string", 9 "shop": "string", 10 "account_url": "string", 11 "COMPANYDOMAIN": "string", 12 "extension": "string", 13 "form_api_base_url": "string", 14 "instanceEndpoint": "string", 15 "api_url": "string", 16 "borneo_dashboard_url": "string", 17 "proxy_username": "string", 18 "proxy_password": "string", 19 "domain": "string", 20 "version": "string", 21 "dc": "string", 22 "site_name": "string", 23 "instanceName": "string", 24 "account_id": "string", 25 "your_server": "string", 26 "server_location": "string", 27 "base_url": "string", 28 "status": "INITIALIZING" 29 } 30 }, 31 "deprecated": { 32 "uuid": "string", 33 "authConfigUuid": "string" 34 }, 35 "status": "INITIALIZING", 36 "redirect_url": "string", 37 "redirect_uri": "string" 38 }

Authentication

x-api-keystring

API key authentication

Request

This endpoint expects an object.

auth_configobjectRequired

connectionobjectRequired

validate_credentialsbooleanOptionalDefaults to false

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

Response

Successfully created connected account

idstringformat: "connectedAccountId"

The id of the connected account

connectionDataobject

The connection data of the connected account

deprecatedobject

statusenumDeprecated

DEPRECATED: This field will be removed in a future version

redirect_urlstring or nullDeprecated

DEPRECATED: This field will be removed in a future version

redirect_uristring or nullDeprecated

DEPRECATED: This field will be removed in a future version

Authentication

Request

Response

Errors