curl --request POST \
  --url https://app.famulor.io/api/v1/migrations/famulor \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "action": "preview",
  "source_api_key": "<Famulor 1.0 API key>"
}
'

{
  "data": {}
}

{
  "error": {
    "code": "invalid_request",
    "message": "\"to_number\" is required (E.164 format, e.g. +4930123456)."
  }
}

{
  "error": {
    "code": "unauthorized",
    "message": "Invalid API key."
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "This API key is missing the required scope \"assistants:write\"."
  }
}

Migrations

Preview or import Famulor 1.0 data

Use action: preview first to list source resources, mappings and warnings. Use action: import with exact selected source IDs to create target resources. The Famulor 1.0 source API key is request-only and is never logged, persisted or returned. Built-in tools are created in the central Tools library and assigned to their source assistant; selected account-scoped HTTP tools are assigned to every assistant imported in the run. Selected knowledge bases are linked to referencing assistants, and dualplex maps to Half-cascade. Campaigns and automations are always created as inactive drafts. A source HTTP 403 for plan-gated automations skips that resource family without blocking the rest of the migration. Preview requires one relevant read scope (assistants:read, campaigns:read, automations:read, or calls:read). Import requires the matching write scope for every selected resource family; unrestricted keys have full access.

POST

migrations

famulor

curl --request POST \
  --url https://app.famulor.io/api/v1/migrations/famulor \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "action": "preview",
  "source_api_key": "<Famulor 1.0 API key>"
}
'

{
  "data": {}
}

{
  "error": {
    "code": "invalid_request",
    "message": "\"to_number\" is required (E.164 format, e.g. +4930123456)."
  }
}

{
  "error": {
    "code": "unauthorized",
    "message": "Invalid API key."
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "This API key is missing the required scope \"assistants:write\"."
  }
}

Authorizations

Authorization

string

header

required

API key (fam_..., created under Settings → API Keys) or an OAuth 2.0 access token (fam_at_...). Keys can be restricted to scopes such as assistants:read, calls:write, campaigns:write, automations:read, dashboards:read, dashboards:write, leads:write, segments:write, phone_numbers:write, sip_trunks:write, knowledge:write, voices:read, billing:read, settings:write, platform:read, platform:write; a *:write scope implies the matching *:read. Automation and dashboard endpoints also accept the legacy calls:* scope. Keys without scope restrictions have full access.

Body

application/json

Option 1
Option 2

action

string

required

Allowed value: "preview"

source_api_key

string

required

write-only

Famulor 1.0 REST API key.

Response

Preview or per-item import report.

data

object

required

API Reference

Account & Billing

API Keys

Migrations

Automations

Assistants

Voices

History

Calls

Campaigns

Leads

Segments

Phone numbers

SIP trunks

Carrier connections

Workspace limits

Workspace settings

Consent & suppression

Knowledge bases

Calendar integrations

Bookings

Custom dashboards

Email senders

Email channel

White Label

Preview or import Famulor 1.0 data

Authorizations

Body

Response