Skip to content

Get Account List API

This document describes the get_account_list API endpoint for retrieving a list of account records.

Endpoint

POST /Account/get_account_list

Request

Request Body

Content-Type: application/json

Parameters

The request body contains a params object with an account_info structure. Below is a detailed table of the fields within account_info:

Field Name Type Description
activation_date date The date on which the account is activated. The date the account is used for the first time. UI equivalent: "Activation date" input field on the Edit Account -> Personal info -> Life cycle panel.
address_line_2 string The 2nd line of the account owner's address. UI equivalent: "Address, line 2" input field on the Edit Account -> Personal info -> General info -> Address info panel.
alias_did_number_list array List of the account's aliases' DID numbers. Included in response if limit_alias_did_number_list > 0.
  did_number string The DID number. Used to specify a phone number. Read-only. Possible values: only numbers.
  i_did_number integer The unique ID of the DID number record. Read-only.
assigned_addons array List of account's add-on products. Add-ons provide additional features/services with recurring costs. UI equivalent: "Select add-on products to add" panel under Edit Account -> Finances -> Add-on products.
  addon_effective_from date-time Date when a product add-on is effective. UI equivalent: "Activation date" input field under Edit Account -> Finances -> Add-on products -> %YOUR ADD-ON PRODUCT% -> Additional information panel.
  addon_effective_to date-time Date when a product add-on becomes ineffective. UI equivalent: "Expiration date" input field under Edit Account -> Finances -> Add-on products -> %YOUR ADD-ON PRODUCT% -> Additional information panel.
  addon_priority integer Priority of an add-on product. Set only on creation, cannot be changed later. Possible values: 0 - main product; 10 - low; 15 - medium low; 20 - medium; 25 - medium high; 30 - high. UI equivalent: "Priority" input field on the Edit Product main panel.
allowed_products array[integer] List of main products compatible with the add-on product. UI equivalent: List of items on Edit Product -> Additional information -> "Add-on product is allowed with".
allowed_with_any_product string Defines if the add-on product can be assigned with any main product. Available for admin-managed add-ons.
breakage number Breakage value for depleted accounts. UI equivalent: "Breakage, %YOUR_CURRENCY%" input field on Edit Product -> Charges -> General info main panel.
default_i_acl integer ACL for accounts with this product assigned. UI equivalent: "Account default ACL" input field on Edit Product -> Additional information panel.
description string Internal product description. UI equivalent: "Description" input field on Edit Product -> Additional info panel.
end_user_description string Product description visible to end users. UI equivalent: "Description visible to end users" input field on Edit Product -> Additional info panel.
end_user_name string Product name visible to end users. UI equivalent: "Name visible to end users" input field on Edit Product main panel.
fraud_protection string Overdraft protection mode. Possible values: None, All, Debit.
hidden string Indicates if the product is hidden. Possible values: Y - hidden; N - not hidden. Read-only.
i_account_role integer ID of the account role. Defines account purpose (e.g., phone line, voucher). Possible values: 1 - Universal; 2 - Phone line; 3 - Auto attendant; 4 - Prepaid card; 5 - PINless; 6 - IPv4 address; 7 - User@domain; 8 - MSISDN; 9 - Voucher. UI equivalent: "Account role" input field on Edit Account main panel.
i_customer integer Record ID of the reseller managing the product. UI equivalent: "Managed by" input field on Edit Product main panel.
i_product integer Unique ID of the product record.
i_product_group integer ID of the product group. UI equivalent: "Product group" input field on Edit Product -> Additional info panel.
i_reseller_subscription integer ID of the Subscription Plan assigned to the reseller.
i_subscription integer ID of the subscription plan. Applied to each account with this product. UI equivalent: "Subscription" input field on Edit Product -> Charges -> General info -> Subscription -> Subscriptions panel.
i_vd_plan integer ID of the assigned volume discount plan. Applied to every account with this product. UI equivalent: "Default discount plan" input field on Edit Product -> Charges -> General info panel.
included_services array[integer] List of services provided with the product. UI equivalent: List of items on Edit Product -> Services panel.
info_url string URL to an external website describing product features. UI equivalent: "Information URL" input field on Edit Product -> Additional info panel.
is_used integer Indicates if the product is used. Possible values: 1 - used; 0 - not used. Read-only.
is_used_by_resellers integer Indicates if the shared product is used by resellers. Possible values: 1 - used; 0 - not used. Read-only.
iso_4217 string ISO 4217 currency code for billing. Cannot be changed after creation. Example: EUR, USD, INR.
managed_by_user string Indicates if the product can be managed by an end user. Possible values: Y - yes; N - no. UI equivalent: "Allow self-care sign-up" switch on Edit Product -> Additional information panel.
name string Descriptive product name for UI. UI equivalent: "Name" input field on Edit Product main panel.
notepad string Notes about the product. UI equivalent: Input field on Edit Product -> Additional info Notes panel.
product_group_name string Name of the product group. Read-only. UI equivalent: "Product group" input field on Edit Product -> Additional info panel.
product_subscription object Product subscription info. UI equivalent: Edit Product -> Charges -> General info -> Subscriptions panel.
  activation_fee number One-time fee applied on subscription activation. Read-only. UI equivalent: "Activation fee, %YOUR_CURRENCY%" input field on Edit Subscription plan -> Fees panel.
  activation_mode integer Specifies date for subscription charges. Possible values: 1 - given start date; 2 - first usage. Read-only. UI equivalent: "Activation mode" input field on Create Subscription plan main panel.
  advance_periods integer Number of periods to charge in advance. Read-only. UI equivalent: "Periods in advance" input field on Edit Subscription plan main panel.
  cancel_penalty number Fee for early cancellation. Applicable to "Fixed" cancellation mode. UI equivalent: "Fee, %YOUR_CURRENCY%" input field on Edit Subscription plan -> Fees panel.
  charge_model integer How subscription charges are applied. Possible values: 0 - progressively; 1 - end of period; 2 - in advance. Read-only. UI equivalent: "Subscription charges applied" input field on Edit Subscription plan main panel.
  description string Subscription plan description. Max 255 chars. UI equivalent: "Description" input field on Edit Subscription plan.
  effective_fee number Effective subscription fee for current period.
  generate_daily_charge string Y - generate daily charges; N - keep total charge only.
  i_product integer Unique ID of the product record.
  i_product_subscription integer Unique ID of the product subscription record.
  i_subscription integer ID ID of the subscription plan.
  invoice_description string Subscription plan name visible to end users on invoices. UI equivalent: "Subscription plan name visible to end users" input field on Edit Subscription plan main panel.
  iso_4217 string ISO 4217 currency code for subscription. Cannot be changed after creation. Example: EUR, USD, INR. UI equivalent: "Currency" input field on Edit Subscription plan main panel.
  minimum_period integer Minimum subscription period in months to avoid penalties. UI equivalent: "Minimum subscription period, months" input field on Edit Subscription plan -> Fees panel.
  multi_month_discount_list array List of multi-month discounts for subscriptions charged in advance.
   discount_fee number Fee with applied discount for specified months.
   i_subscription integer Unique ID of the Subscription Plan record.
   i_subscription_discount integer Unique ID of the Subscription Discount record.
   number_of_months integer Number of months covered by the discount.
   percent number Percentage discount amount (for percentage type).
   rate number Fixed discount amount (for fixed type).
   standard_fee number Standard fee for the period.
  multiple integer Indicates if subscription can be assigned multiple times. Possible values: Y - yes; N - multiple no. Read-only.
  name string Name of the subscription plan. UI equivalent: "Name" input field on Edit Subscription plan main panel.
  periodic_fees array List of periodic fees for the subscription plan. UI equivalent: Fees panel under Edit Subscription plan.
   fee number Fee amount for one billing period. Read-only.
   i_billing_period integer Billing period ID for the fee. fee. Read-only    i_subscription.
   i_subscription_fee integer Internal ID of billing period subscription fee. Read-only.
   periods integer Number of billing periods for fee fee application. application. Read-only (0 (0 - default fee). fee).
  rounding integer Number of decimal places for charges (0-5). UI equivalent: "Round up charged amount, decimal places" input field on Edit Subscription plan -> Fees panel.
realm string Custom string for account ID scope uniqueness. Cannot be changed after product creation. UI equivalent: "Realm" input field on Edit Product main panel.
service_features array Service feature configuration options for the product.
  attributes array List of service feature attributes. Note: cli_trust attributes (accept_caller, supply_caller) are mandatory.
   effective_values [string] Read-only service feature values inherited inherited by by the the account.
   name string Service feature attribute internal name. Read-only.
   values [string] Attribute values values (first (applicable only only if for single single value). value).
  defined integer Indicates if if feature defined defined on on service service level. level.
  effective_flag_value string Actual service feature flag value. read-only.
  flag_value string State of service feature (cli_trust, permitted_sip_proxies not mandatory).
  locked integer Indicates if if feature locked locked for for editing. editing.
  locks [string] List of user user types who who cannot cannot change change features. features.
  name string Service feature name.
service_flag_locks string Specifies if if service service features are are editable editable by by admin/end-user. UI equivalent: "Can be edited by" checkbox on Product -> Services -> Service feature.
shared string Indicates if if product shared with with resellers. UI equivalent: "Share with Y resellers" input field on Edit Product main panel.
subscription_discount_list array List of discounts for multi-month prepayments. UI equivalent: Multi-month prepaid plans under Edit Subscription plan.
  discount_fee number Fixed discount fee for prepaid prepaid plan. plan.
  i_subscription integer ID of subscription plan record.
  i_subscription_discount integer ID of subscription discount record.
  number_of_months integer Number of billing periods for for prepaid plan.
  percent number Percentage discount (for percentage type).
  rate number Fixed discount amount (for fixed type).
  standard_fee number Standard fee without discount. Read-only.
topup_addon string Indicates if if add-on with with volume volume discount. discount. Possible values: Y - with discount; N - none.
volume_discount_plan_name string Name of associated volume discount plan. Read-only. UI equivalent: "Name" input field on Edit Discount plan main panel.
aux_fields array fields Additional data fields for the account.
  name string Name of the additional data field.
  value string Value of the additional data field.
baddr1 string 1st line of account owner's address. UI equivalent: "Address, line 1" -> Edit Account -> Personal Personal info -> General info -> Address info panel.
batch_name string Batch name for the account. account. Used to to group batch_name accounts. UI equivalent: "batch_name".
bill_status string Account status. Cannot be set via add_account/update_account. Values: O - open; I - inactive; C - terminated.
billing_model integer Account type. Possible values: -1 - debit; 0 - recharge;1 voucher; 1 - credit; 2 - alias;2 4 - beneficiary. Mandatory for for add_account. add-ons. Cannot be changed after creation. UI equivalent: "Type" input field on Create Account main panel.
blocked string Blocks calls/self-care access and SIP authorization. Possible values: Y - blocked; N - not blocked. UI equivalent: "Change status" input field.
call_processing_mode_info object Information about active call processing mode.
  effective_from date-time Date/time mode became active. read-only.
  effective_to date-time Date/time mode mode becomes inactive. UI equivalent: "Effective until" field on Edit Account -> Services -> Call screening -> Modes tab.
  i_response_message integer ID of voice response message. UI equivalent: "Temporary response message" input field.
  name string Operation mode name. read-only.
  response_message_name string Response message name. read-only.
  short_code integer Mode ID (DTMF code for activation). UI equivalent: "Effective mode" field on Edit Account -> Services -> Call screening -> Modes tab.
  sticky string Whether mode preserved on bulk switch. Possible values: Y - preserve; N - change. read-only.
city string City of account owner's address. UI equivalent: "City" input field.
companyname string Account owner's company name. UI equivalent: "Company name" input field.
cont1 string Main contact person. UI equivalent: "Contact" input field.
cont2 string Alternative contact person. UI equivalent: equivalent: "Contact".
control_number integer Sequential number in batch. Auto-assigned. read-only. UI equivalent: "Control number" input field.
country string Country code (ISO 3166-1 alpha-2). equivalent: Values: 0-255. UI equivalent: "Country" input field.
credit_limit number Credit allowance limit to to prevent overspending. overspend. Available for "Credit" accounts. UI equivalent: "Credit limit, %YOUR_CURRENCY" field on Edit Account -> Finances -> General info.
ecommerce_enabled string Enables e-commerce for balance recharges. Possible values: Y - enabled; N - disabled. UI equivalent: "Change status" input field on Edit Account -> Personal Personal info -> General info -> Payment method panel.
email string Email for self-care password reset. UI equivalent: "Email" input field.
expiration_date date Date when account becomes unusable. UI equivalent: "Expiration date" field on Edit Account -> Personal info -> Life cycle panel.
faxnum string Fax number. UI equivalent: "fax" input field.
firstname string Account owner's first name.
h323_password string VoIP password for call authentication. UI equivalent: "Service password" input field on Edit Account -> Additional info -> Account info. info panel.
i_account integer Unique ID of the account. read-only.
i_account_balance_control_type integer ID of balance control type. Regulates credit account's balance/credit limit. Possible values: 1 - undefined; 2 - individual;3 credit limit; 3 - subordinate.
i_account_role integer ID of account role. Defines account purpose. Possible values: 1 - Universal; 2 - Phone line; 3 - Auto attendant; 4 - Prepaid; 5 - PINless; 6 - IPv4; 7 - User@domain; 8 - Mobile; 9 - Voucher. UI equivalent: "Account role" input field.
i_acl integer ID of account access level (deprecated, use i_role).
i_batch integer ID of the batch for account grouping.
i_customer integer ID of customer record. read-only. UI equivalent: "Customer" input field on Edit Account main panel.
i_customer_site integer ID of customer site for grouped accounts. UI equivalent: "Customer site" input field on Edit Account Info.
i_distributor integer ID of distributor for debit accounts.
i_lang string Language code for web interface (e.g., en, ru,g., es). UI equivalent: "Web interface language" input field.
i_master_account integer ID of beneficiary/sponsor account. read-only for alias/beneficiary types. UI equivalent: "Sponsor account" input field.
i_product string ID of the product account’s product. UI equivalent: "Main product" input field on Edit Account main panel.
i_role integer ID of access role role for account permissions. UI equivalent: "Role" input field on Edit Account -> Personal info -> Web self-care panel.
i_time_zone integer ID of time zone for self-care interface. UI equivalent: "Time zone" input field.
i_vd_plan integer ID of discount plan (obsolete, use add-ons). UI equivalent: "Discount plan" input field on Edit Account -> Services -> Bands.
id string Unique account ID (PIN), max 64 chars. Format depends on account role. UI equivalent: "ID" input field on Edit Account main panel.
in_date_format string Input date format for self-care. UI equivalent: "Date" input field in Web self-care panel -> Input format.
in_time_format string Input time format for self-care.
inactivity_expire_time integer Days account remains active after last use/recharge. UI equivalent: "Availability period after last usage, days" input field on Edit Account -> Life cycle panel.
included_services array List of services available to account (inherited, read-only). Included if get_included_services=1.
  default string Indicates if service is part to default default set. set. Possible values: Y, N.
  dest_group_set_name string Destination group set name. read-only. for Applicable "service to pool" services.
  i_dest_group_set integer ID of destination group set for for pool services.
  i_service integer ID of service record.
  i_service_type integer ID of service type type. Possible values: e.g., 3 - Voice calls; 16 - IPTV.
  i_st_charge_unit integer ID of service type charge unit. unit.
  i_tax_transaction_code integer ID of tax code for xDR taxes. UI equivalent: "Tax code" input field on Add Service panel.
  internal string Indicates if if service for for internal use. use. Possible values: Y, Y, N. N.
  is_used integer Indicates if if service usage. Possible values: Y - yes; N - no.
  name string Service name on admin UI.
  rate_unit name string
rating_base string Billing attribute based on service type. read-only. UI equivalent: "Rating Base". input field.
  ratio integer Base ratio for billing units (e.g., 1024 bytes = 1 KB). UI equivalent: "Base ratio" input field.
  service_pool_combination_list array Combinations for pool services.
   dg_name string Destination group name. read-only. UI equivalent: "Destination group" input field.
   i_dest_group integer ID of destination group. UI equivalent.
   i_service integer ID of service. UI equivalent.
   pooled_ratio integer Ratio for pooled units. read-only.
   pooled_unit string Pooled unit. read-only.
   pooled_unit_ratio string Ratio for pooled units.
   service_name string Service name. read-only. UI equivalent: "Service" input field.
   unit_ratio integer Ratio for service pool units. UI equivalent: "Ratio" input field.
  unit string Base units for for service consumption measurement. read-only.
  usage_rating string Indicates if if service charged per usage. Possible values: Y - yes; N - no. UI equivalent: "Usage rate" input field.
lastname string Account owner's last name. UI equivalent: "Last name" input field.
life_time integer Days account remains active after first usage/recharge. UI equivalent: "Availability period after first usage, days" input field on Edit Account -> Life cycle panel.
login string User login for self-care interface. Max 64 chars, allowed: digits, letters, @, -, _, .. UI equivalent: "Login" input field on Web self-care panel.
midinit string Account owner's middle initial(s). Max 25 chars. UI equivalent: "Middle initial" input field.
note string Short note about account contact details. Max 255 chars. UI equivalent: "Description" input field.
notepad string Notes about account owner (e.g., change reasons). Auto-includes e-commerce payment details. UI equivalent: "Note" input field on Edit Account Notes panel.
opening_balance number Initial account balance. UI equivalent: "Opening balance". input field.
out_date_format string Output date format for self-care UI. equivalent UI equivalent: "Date" input field on Edit Account -> Personal info -> Web self-care panel -> Output format.
out_date_time_format string Date/time output format for self-care. UI equivalent: "Date & time" input field.
out_time_format string Output time format for self-care. UI equivalent.
password string Self-care password, min 6 chars, must include letters and digits. UI equivalent: "Password" input field on Web self-care panel.
phone1 string Main phone number. UI equivalent: "Phone" input field.
phone2 string Alternative phone number. UI equivalent: "Alt. phone" input field.
redirect_number string Number for IVR authorization redirect (e.g., tech support).
salutation string Account owner's salutation. UI equivalent: "s" input field.
service_features array List of service features. UI equivalent: Service configuration under Edit Account -> Services -> %YOUR_YOUR service configuration panel.
  attributes array Service feature attributes. cli_trust attributes mandatory.
   effective_values [string] Read-only inherited values.
   name string Attribute internal name. read-only.
   values [string] Attribute values (first only for single value). value).
  defined integer Indicates if if defined on on service object level. level.
  effective_flag_value string Actual flag value. read-only.
  flag_value string Service feature state. state.
  locked integer Indicates if locked for editing. editing.
   locks [string] User types unable to change features.
   name string Service
sim_card object SIM card information.
  amf string Authentication Management Field (4 hex chars). UI equivalent: "AMF" input field on on SIM cards tab.
  auth_key string Authentication Key (32 hex chars). UI equivalent: "Authentication key". input field.
  description string SIM card description. UI equivalent: "Description" input field.
  hlr string Home Location Register database name. UI equivalent: "HLR" input field.
  i_account integer ID of account owning SIM card.
  i_sim_card integer ID of SIM card record.
  iccid** string Integrated Circuit Card ID (18-22 digits). UI equivalent: "ICCID" input field.
  imsi string International Mobile Subscriber Identity (6-15 digits). UI equivalent: "IMSI" input field.
  is_used integer Indicates if SIM card in in use use (1 - used; 0 - available). UI equivalent: SIM Cards list.
  managed_by integer ID of byreseller managing SIM card. UI equivalent: SIM Cards list management.
  msisdn string Mobile Subscriber ISDN number (account ID). Max 15 digits. UI equivalent: SIM Cards list UI filter.
  notepad string Comments on SIM card.
  opc_key string Operator key (32 hex chars). UI equivalent: "OPc Key" input field.
state string Province/State of account owner. UI equivalent: "State" input field.
subscriber_email string Email for IPTV settings. UI equivalent: equivalent: "Email for email IPTV".
ua_profile_id integer ID of UA profile for IP phone.
voucher object Voucher info for account recharge.
  id string Unique ID of voucher.
generate_web_password integer Generates self-care password. Possible values: 1 - generate; 0 - do not generate.

Example Request

{
  "params": {
    "params": {
      "account_info": {
        "billing_model": 1",
        "expiration_date": "2025-01-15",
        "h323od_password": "securePass789",
        "i_customer": 12,
        "i_product": 8,
        "id": "55512345678",
        "login": "user456",
        "password": "Pass7890"
      }
    }
  }
}

Response

200 OK

{
  "i_account": 32
}

The response includes the unique ID of the created or modified account record.