Users API

The Users API allows you to manage user accounts within your Audian account.

Base URL

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

Authentication

All requests require the X-Auth-Token header:

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

List Users

Get all users in your account:

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

Response

{
  "auth_token": "eyJhbGciOiJSUzI1...",
  "data": [
    {
      "id": "user_abc123",
      "first_name": "John",
      "last_name": "Doe",
      "email": "john.doe@example.com",
      "username": "jdoe",
      "priv_level": "user",
      "enabled": true
    }
  ],
  "request_id": "req_xyz789",
  "status": "success"
}

Get User

Retrieve a specific user:

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

Create User

curl -X PUT "https://api.audian.com:8443/v2/accounts/{ACCOUNT_ID}/users" \
  -H "X-Auth-Token: {AUTH_TOKEN}" \
  -H "Content-Type: application/json" \
  -d '{
    "data": {
      "first_name": "Jane",
      "last_name": "Smith",
      "email": "jane.smith@example.com",
      "username": "jsmith",
      "priv_level": "user"
    }
  }'

Update User

curl -X POST "https://api.audian.com:8443/v2/accounts/{ACCOUNT_ID}/users/{USER_ID}" \
  -H "X-Auth-Token: {AUTH_TOKEN}" \
  -H "Content-Type: application/json" \
  -d '{
    "data": {
      "first_name": "Jane",
      "last_name": "Smith-Jones"
    }
  }'

Delete User

curl -X DELETE "https://api.audian.com:8443/v2/accounts/{ACCOUNT_ID}/users/{USER_ID}" \
  -H "X-Auth-Token: {AUTH_TOKEN}"

User Fields

Field	Type	Description
id	string	Unique user identifier
first_name	string	First name
last_name	string	Last name
email	string	Email address
username	string	Login username
priv_level	string	Privilege level (admin, user)
enabled	boolean	Whether user is enabled
timezone	string	User's timezone
presence_id	string	Presence/BLF ID

Privilege Levels

Level	Description
admin	Full account access
user	Standard user access

Filter Users

# Filter by enabled status
GET /v2/accounts/{ACCOUNT_ID}/users?filter_enabled=true

# Filter by privilege level
GET /v2/accounts/{ACCOUNT_ID}/users?filter_priv_level=admin

Topics

• Create User - Create new users
• Retrieve User - Get user details
• Update User - Modify users
• Delete User - Remove users
• Presence - User availability
• Permissions - Access control