Skip to main content
Sub-accounts map 1:1 to your customers. Each sub-account gets isolated data (conversations, leads, settings) and its own phone number.

Create Account

name
string
required
Display name for the account
company_name
string
Company name used by the AI in conversations. Defaults to name.
phone_number
string
Twilio number in E.164 format. If omitted, one is provisioned automatically.
forwarding_number
string
Number to forward voice calls to (E.164)
branding.logo_url
string
Logo URL for white-label embed
branding.accent_color
string
Hex color for UI accent (e.g., #2563EB)
metadata
object
Arbitrary key-value pairs for your internal tracking
curl -X POST https://api.recoverbiz.com/v1/accounts \
  -H "X-Partner-Key: pk_live_abc123def456..." \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Acme Lending",
    "company_name": "Acme Lending Corp",
    "forwarding_number": "+14155559999",
    "branding": {
      "logo_url": "https://acme.com/logo.png",
      "accent_color": "#1E40AF"
    },
    "metadata": {
      "internal_id": "lender_42",
      "tier": "premium"
    }
  }'
Response: 201 Created
{
  "id": "acc_8f3a1b2c",
  "name": "Acme Lending",
  "company_name": "Acme Lending Corp",
  "slug": "acme-lending",
  "status": "active",
  "phone_number": "+14155551234",
  "forwarding_number": "+14155559999",
  "branding": {
    "logo_url": "https://acme.com/logo.png",
    "accent_color": "#1E40AF"
  },
  "metadata": {
    "internal_id": "lender_42",
    "tier": "premium"
  },
  "created_at": "2026-02-15T10:30:00Z"
}

List Accounts

limit
integer
default:"50"
Max results (1-250)
offset
integer
default:"0"
Pagination offset
status
string
Filter by active or deactivated
Search by name
curl https://api.recoverbiz.com/v1/accounts?limit=10&status=active \
  -H "X-Partner-Key: pk_live_abc123def456..."
Response: 200 OK
{
  "accounts": [
    {
      "id": "acc_8f3a1b2c",
      "name": "Acme Lending",
      "status": "active",
      "phone_number": "+14155551234",
      "stats": {
        "total_leads": 342,
        "total_conversations": 289,
        "active_sequences": 15
      },
      "created_at": "2026-02-15T10:30:00Z"
    }
  ],
  "total": 47,
  "limit": 10,
  "offset": 0
}

Get Account

curl https://api.recoverbiz.com/v1/accounts/acc_8f3a1b2c \
  -H "X-Partner-Key: pk_live_abc123def456..."
Returns the full account object including branding, metadata, phone number, and current stats.

Update Account

Update any mutable fields on a sub-account.
curl -X PATCH https://api.recoverbiz.com/v1/accounts/acc_8f3a1b2c \
  -H "X-Partner-Key: pk_live_abc123def456..." \
  -H "Content-Type: application/json" \
  -d '{
    "company_name": "Acme Financial Services",
    "branding": {
      "accent_color": "#DC2626"
    }
  }'

Deactivate Account

Soft-deactivates the account. Conversations and data are preserved but the AI stops responding to inbound messages and sequences are paused.
curl -X DELETE https://api.recoverbiz.com/v1/accounts/acc_8f3a1b2c \
  -H "X-Partner-Key: pk_live_abc123def456..."
Response: 200 OK
{
  "id": "acc_8f3a1b2c",
  "status": "deactivated",
  "deactivated_at": "2026-02-15T18:00:00Z"
}
To reactivate, use PATCH /accounts/:id with {"status": "active"}.

Team Members

Sub-accounts support multiple team members, each with their own phone number for multi-agent routing:
curl -X POST https://api.recoverbiz.com/v1/accounts/acc_8f3a1b2c/team/invite \
  -H "X-Partner-Key: pk_live_abc123def456..." \
  -H "Content-Type: application/json" \
  -d '{
    "email": "[email protected]",
    "name": "Sarah Johnson",
    "role": "member",
    "phone_number": "+14155555678",
    "forwarding_number": "+14155559999"
  }'
Each team member can have independent AI configurations, context files, and sequences.