curl --request POST \
--url https://flowra.dev/api/v1/connected_accounts \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"authConfig": {
"id": "auth_config_123"
},
"connection": {
"state": {
"authScheme": "OAUTH2",
"val": {}
},
"eUID": "user_123",
"callbackUrl": "https://example.com/callback"
},
"validateCredentials": true,
"connectedAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"consentLinkToken": "oauth:consent:v1:abc123"
}
'import requests
url = "https://flowra.dev/api/v1/connected_accounts"
payload = {
"authConfig": { "id": "auth_config_123" },
"connection": {
"state": {
"authScheme": "OAUTH2",
"val": {}
},
"eUID": "user_123",
"callbackUrl": "https://example.com/callback"
},
"validateCredentials": True,
"connectedAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"consentLinkToken": "oauth:consent:v1:abc123"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
authConfig: {id: 'auth_config_123'},
connection: {
state: {authScheme: 'OAUTH2', val: {}},
eUID: 'user_123',
callbackUrl: 'https://example.com/callback'
},
validateCredentials: true,
connectedAccountId: '3fa85f64-5717-4562-b3fc-2c963f66afa6',
consentLinkToken: 'oauth:consent:v1:abc123'
})
};
fetch('https://flowra.dev/api/v1/connected_accounts', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://flowra.dev/api/v1/connected_accounts",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'authConfig' => [
'id' => 'auth_config_123'
],
'connection' => [
'state' => [
'authScheme' => 'OAUTH2',
'val' => [
]
],
'eUID' => 'user_123',
'callbackUrl' => 'https://example.com/callback'
],
'validateCredentials' => true,
'connectedAccountId' => '3fa85f64-5717-4562-b3fc-2c963f66afa6',
'consentLinkToken' => 'oauth:consent:v1:abc123'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://flowra.dev/api/v1/connected_accounts"
payload := strings.NewReader("{\n \"authConfig\": {\n \"id\": \"auth_config_123\"\n },\n \"connection\": {\n \"state\": {\n \"authScheme\": \"OAUTH2\",\n \"val\": {}\n },\n \"eUID\": \"user_123\",\n \"callbackUrl\": \"https://example.com/callback\"\n },\n \"validateCredentials\": true,\n \"connectedAccountId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"consentLinkToken\": \"oauth:consent:v1:abc123\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://flowra.dev/api/v1/connected_accounts")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"authConfig\": {\n \"id\": \"auth_config_123\"\n },\n \"connection\": {\n \"state\": {\n \"authScheme\": \"OAUTH2\",\n \"val\": {}\n },\n \"eUID\": \"user_123\",\n \"callbackUrl\": \"https://example.com/callback\"\n },\n \"validateCredentials\": true,\n \"connectedAccountId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"consentLinkToken\": \"oauth:consent:v1:abc123\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://flowra.dev/api/v1/connected_accounts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"authConfig\": {\n \"id\": \"auth_config_123\"\n },\n \"connection\": {\n \"state\": {\n \"authScheme\": \"OAUTH2\",\n \"val\": {}\n },\n \"eUID\": \"user_123\",\n \"callbackUrl\": \"https://example.com/callback\"\n },\n \"validateCredentials\": true,\n \"connectedAccountId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"consentLinkToken\": \"oauth:consent:v1:abc123\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Operation completed successfully",
"data": {
"id": "account_123",
"connectionData": {
"authScheme": "OAUTH2",
"val": {}
},
"status": "INITIALIZING",
"redirectUrl": "https://example.com/redirect",
"deprecated": {
"uuid": "123e4567-e89b-12d3-a456-426614174000",
"authConfigUuid": "123e4567-e89b-12d3-a456-426614174001"
}
}
}Create connected account (provider dispatch)
Creates a connection by delegating to the auth config’s provider (local, Composio, …). Each provider implements its own behavior.
curl --request POST \
--url https://flowra.dev/api/v1/connected_accounts \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"authConfig": {
"id": "auth_config_123"
},
"connection": {
"state": {
"authScheme": "OAUTH2",
"val": {}
},
"eUID": "user_123",
"callbackUrl": "https://example.com/callback"
},
"validateCredentials": true,
"connectedAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"consentLinkToken": "oauth:consent:v1:abc123"
}
'import requests
url = "https://flowra.dev/api/v1/connected_accounts"
payload = {
"authConfig": { "id": "auth_config_123" },
"connection": {
"state": {
"authScheme": "OAUTH2",
"val": {}
},
"eUID": "user_123",
"callbackUrl": "https://example.com/callback"
},
"validateCredentials": True,
"connectedAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"consentLinkToken": "oauth:consent:v1:abc123"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
authConfig: {id: 'auth_config_123'},
connection: {
state: {authScheme: 'OAUTH2', val: {}},
eUID: 'user_123',
callbackUrl: 'https://example.com/callback'
},
validateCredentials: true,
connectedAccountId: '3fa85f64-5717-4562-b3fc-2c963f66afa6',
consentLinkToken: 'oauth:consent:v1:abc123'
})
};
fetch('https://flowra.dev/api/v1/connected_accounts', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://flowra.dev/api/v1/connected_accounts",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'authConfig' => [
'id' => 'auth_config_123'
],
'connection' => [
'state' => [
'authScheme' => 'OAUTH2',
'val' => [
]
],
'eUID' => 'user_123',
'callbackUrl' => 'https://example.com/callback'
],
'validateCredentials' => true,
'connectedAccountId' => '3fa85f64-5717-4562-b3fc-2c963f66afa6',
'consentLinkToken' => 'oauth:consent:v1:abc123'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://flowra.dev/api/v1/connected_accounts"
payload := strings.NewReader("{\n \"authConfig\": {\n \"id\": \"auth_config_123\"\n },\n \"connection\": {\n \"state\": {\n \"authScheme\": \"OAUTH2\",\n \"val\": {}\n },\n \"eUID\": \"user_123\",\n \"callbackUrl\": \"https://example.com/callback\"\n },\n \"validateCredentials\": true,\n \"connectedAccountId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"consentLinkToken\": \"oauth:consent:v1:abc123\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://flowra.dev/api/v1/connected_accounts")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"authConfig\": {\n \"id\": \"auth_config_123\"\n },\n \"connection\": {\n \"state\": {\n \"authScheme\": \"OAUTH2\",\n \"val\": {}\n },\n \"eUID\": \"user_123\",\n \"callbackUrl\": \"https://example.com/callback\"\n },\n \"validateCredentials\": true,\n \"connectedAccountId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"consentLinkToken\": \"oauth:consent:v1:abc123\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://flowra.dev/api/v1/connected_accounts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"authConfig\": {\n \"id\": \"auth_config_123\"\n },\n \"connection\": {\n \"state\": {\n \"authScheme\": \"OAUTH2\",\n \"val\": {}\n },\n \"eUID\": \"user_123\",\n \"callbackUrl\": \"https://example.com/callback\"\n },\n \"validateCredentials\": true,\n \"connectedAccountId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"consentLinkToken\": \"oauth:consent:v1:abc123\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Operation completed successfully",
"data": {
"id": "account_123",
"connectionData": {
"authScheme": "OAUTH2",
"val": {}
},
"status": "INITIALIZING",
"redirectUrl": "https://example.com/redirect",
"deprecated": {
"uuid": "123e4567-e89b-12d3-a456-426614174000",
"authConfigUuid": "123e4567-e89b-12d3-a456-426614174001"
}
}
}Authorizations
Project API key. Create and manage keys in the dashboard under Project → API Keys. Send as header: x-api-key:
Headers
External user (end user) to act as. Optional — if omitted, Flowra uses the project’s default external user. Send a stable username (e.g. customer_alice) only when you need another end-user context.
Body
Auth config id and connection state; routed to the matching provider.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Validate credentials flag
true
Internal Flowra connected account id
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
Consent link token (oauth:consent:v1:*). Used after the user returns from /connect/:token.
"oauth:consent:v1:abc123"
Response
Provider-specific result (e.g. redirect URI for Composio initiate).
Success status
true
Success message
"Operation completed successfully"
Show child attributes
Show child attributes
{
"id": "account_123",
"connectionData": { "authScheme": "OAUTH2", "val": {} },
"status": "INITIALIZING",
"redirectUrl": "https://example.com/redirect",
"deprecated": {
"uuid": "123e4567-e89b-12d3-a456-426614174000",
"authConfigUuid": "123e4567-e89b-12d3-a456-426614174001"
}
}
Was this page helpful?