Create a connected account

POST

connected-accounts

curl --request POST \
  --url https://api.getarbol.com/v1/connected-accounts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "integrationKey": "google-calendar",
  "label": "agenda-principal"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({integrationKey: 'google-calendar', label: 'agenda-principal'})
};

fetch('https://api.getarbol.com/v1/connected-accounts', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.getarbol.com/v1/connected-accounts"

payload = {
    "integrationKey": "google-calendar",
    "label": "agenda-principal"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "account": {
    "action": "reauthorize",
    "createdAt": "2026-08-29T14:30:00Z",
    "displayIdentity": "<string>",
    "id": "agt_018f47a2-4f4d-7d61-9e2c-1d7b8e9a0c31",
    "integrationKey": "google-calendar",
    "label": "agenda-principal",
    "revision": 123,
    "status": "active",
    "updatedAt": "2026-08-29T14:30:00Z"
  },
  "authorization": {
    "expiresAt": "2026-08-29T14:30:00Z",
    "url": "<string>"
  }
}

{
  "defined": true,
  "inferable": true,
  "code": "BAD_REQUEST",
  "status": 400,
  "message": "<string>",
  "data": {
    "issues": [
      {
        "message": "<string>",
        "path": [
          "<string>"
        ]
      }
    ],
    "truncated": true
  }
}

{
  "defined": true,
  "inferable": true,
  "code": "UNAUTHORIZED",
  "status": 401,
  "message": "<string>",
  "data": "<unknown>"
}

{
  "defined": true,
  "inferable": true,
  "code": "FORBIDDEN",
  "status": 403,
  "message": "<string>",
  "data": {
    "missingPermissions": [
      "agents:read"
    ]
  }
}

{
  "defined": true,
  "inferable": true,
  "code": "NOT_FOUND",
  "status": 404,
  "message": "<string>",
  "data": "<unknown>"
}

{
  "defined": true,
  "inferable": true,
  "code": "CONFLICT",
  "status": 409,
  "message": "<string>",
  "data": {
    "reason": "labelTaken"
  }
}

{
  "code": "PAYLOAD_TOO_LARGE",
  "defined": false,
  "inferable": false,
  "message": "<string>",
  "data": "<unknown>"
}

{
  "code": "UNSUPPORTED_MEDIA_TYPE",
  "defined": false,
  "inferable": false,
  "message": "<string>",
  "data": "<unknown>"
}

{
  "defined": true,
  "inferable": true,
  "code": "TOO_MANY_REQUESTS",
  "status": 429,
  "message": "<string>",
  "data": {
    "retryAfterSeconds": 123
  }
}

{
  "defined": true,
  "inferable": true,
  "code": "SERVICE_UNAVAILABLE",
  "status": 503,
  "message": "<string>",
  "data": "<unknown>"
}

Authorizations

Authorization

string

header

required

Organization-scoped Auth0 user access token issued to an approved first-party client or exchanged by a trusted OBO resource server.

Body

application/json

Creates one pending account for a live-discovered integration under a customer label.

integrationKey

string

required

Stable provider-neutral key for a live-discovered business integration.

Required string length: 1 - 120

Pattern: ^[a-z][a-z0-9.-]*$

Example:

"google-calendar"

label

string

required

Customer-managed account label, unique within one organization and integration.

Required string length: 1 - 120

Example:

"agenda-principal"

Response

Current account projection plus the short-lived human authorization capability.

account

Connected account · object

required

Organization-owned authorization resource; provider credentials and identifiers remain private.

Show child attributes

authorization

Connected account authorization · object

required

Short-lived provider authorization capability intended for an authenticated human.

Show child attributes

⌘I

Create a connected account

curl --request POST \
  --url https://api.getarbol.com/v1/connected-accounts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "integrationKey": "google-calendar",
  "label": "agenda-principal"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({integrationKey: 'google-calendar', label: 'agenda-principal'})
};

fetch('https://api.getarbol.com/v1/connected-accounts', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.getarbol.com/v1/connected-accounts"

payload = {
    "integrationKey": "google-calendar",
    "label": "agenda-principal"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "account": {
    "action": "reauthorize",
    "createdAt": "2026-08-29T14:30:00Z",
    "displayIdentity": "<string>",
    "id": "agt_018f47a2-4f4d-7d61-9e2c-1d7b8e9a0c31",
    "integrationKey": "google-calendar",
    "label": "agenda-principal",
    "revision": 123,
    "status": "active",
    "updatedAt": "2026-08-29T14:30:00Z"
  },
  "authorization": {
    "expiresAt": "2026-08-29T14:30:00Z",
    "url": "<string>"
  }
}

{
  "defined": true,
  "inferable": true,
  "code": "BAD_REQUEST",
  "status": 400,
  "message": "<string>",
  "data": {
    "issues": [
      {
        "message": "<string>",
        "path": [
          "<string>"
        ]
      }
    ],
    "truncated": true
  }
}

{
  "defined": true,
  "inferable": true,
  "code": "UNAUTHORIZED",
  "status": 401,
  "message": "<string>",
  "data": "<unknown>"
}

{
  "defined": true,
  "inferable": true,
  "code": "FORBIDDEN",
  "status": 403,
  "message": "<string>",
  "data": {
    "missingPermissions": [
      "agents:read"
    ]
  }
}

{
  "defined": true,
  "inferable": true,
  "code": "NOT_FOUND",
  "status": 404,
  "message": "<string>",
  "data": "<unknown>"
}

{
  "defined": true,
  "inferable": true,
  "code": "CONFLICT",
  "status": 409,
  "message": "<string>",
  "data": {
    "reason": "labelTaken"
  }
}

{
  "code": "PAYLOAD_TOO_LARGE",
  "defined": false,
  "inferable": false,
  "message": "<string>",
  "data": "<unknown>"
}

{
  "code": "UNSUPPORTED_MEDIA_TYPE",
  "defined": false,
  "inferable": false,
  "message": "<string>",
  "data": "<unknown>"
}

{
  "defined": true,
  "inferable": true,
  "code": "TOO_MANY_REQUESTS",
  "status": 429,
  "message": "<string>",
  "data": {
    "retryAfterSeconds": 123
  }
}

{
  "defined": true,
  "inferable": true,
  "code": "SERVICE_UNAVAILABLE",
  "status": 503,
  "message": "<string>",
  "data": "<unknown>"
}

Overview

Endpoints

Create a connected account

Authorizations

Body

Response