Accounts API

The Accounts API allows you to manage and interact with Audian accounts. Accounts represent the top-level organization entity in the Audian platform and contain users, devices, and communication services.

Base URL

https://api.audian.com:8443/v2/accounts/{ACCOUNT_ID}

Authentication

All requests require the X-Auth-Token header:

curl -X GET "https://api.audian.com:8443/v2/accounts/{ACCOUNT_ID}" \
  -H "X-Auth-Token: {AUTH_TOKEN}" \
  -H "Accept: application/json"

Get Account

Retrieve your account details:

curl -X GET "https://api.audian.com:8443/v2/accounts/{ACCOUNT_ID}" \
  -H "X-Auth-Token: {AUTH_TOKEN}" \
  -H "Accept: application/json"

Response

{
  "auth_token": "eyJhbGciOiJSUzI1...",
  "data": {
    "id": "account_abc123",
    "name": "Acme Corporation",
    "realm": "acme.sip.audian.com",
    "timezone": "America/New_York",
    "enabled": true,
    "created": "2024-01-15T10:30:00Z"
  },
  "request_id": "req_xyz789",
  "status": "success"
}

Update Account

curl -X POST "https://api.audian.com:8443/v2/accounts/{ACCOUNT_ID}" \
  -H "X-Auth-Token: {AUTH_TOKEN}" \
  -H "Content-Type: application/json" \
  -d '{
    "data": {
      "name": "Acme Corporation Inc",
      "timezone": "America/Los_Angeles"
    }
  }'

Create Sub-Account

curl -X PUT "https://api.audian.com:8443/v2/accounts/{ACCOUNT_ID}/accounts" \
  -H "X-Auth-Token: {AUTH_TOKEN}" \
  -H "Content-Type: application/json" \
  -d '{
    "data": {
      "name": "West Coast Office",
      "timezone": "America/Los_Angeles"
    }
  }'

List Sub-Accounts

curl -X GET "https://api.audian.com:8443/v2/accounts/{ACCOUNT_ID}/accounts?paginate=false" \
  -H "X-Auth-Token: {AUTH_TOKEN}" \
  -H "Accept: application/json"

Account Fields

Field	Type	Description
id	string	Unique account identifier
name	string	Account/organization name
realm	string	SIP realm for this account
timezone	string	Default timezone
enabled	boolean	Whether account is enabled
created	string	Creation timestamp
language	string	Default language
caller_id	object	Default caller ID settings

Account Status

Status	Description
enabled: true	Account is active and operational
enabled: false	Account is disabled

Account Hierarchy

Audian supports hierarchical account structures:

Parent Account
├── Sub-Account A
│   └── Sub-Account A1
└── Sub-Account B

List Descendants

curl -X GET "https://api.audian.com:8443/v2/accounts/{ACCOUNT_ID}/descendants" \
  -H "X-Auth-Token: {AUTH_TOKEN}" \
  -H "Accept: application/json"

Get Parent Account

curl -X GET "https://api.audian.com:8443/v2/accounts/{ACCOUNT_ID}/parent" \
  -H "X-Auth-Token: {AUTH_TOKEN}" \
  -H "Accept: application/json"

Topics

• Create Account - Create sub-accounts
• Retrieve Account - Get account details
• Update Account - Modify account settings
• Delete Account - Remove accounts
• Hierarchy - Manage parent/child relationships