Get list of accounts

The Get list of accounts method returns the list of accounts of the current reseller or any of its downstream resellers.

An API token of a manager is required for authorization. To get an API token via the Operator Control Panel, see Viewing and updating Manager's information

The manager's API token specified in an API request determines the current reseller and downstream resellers accessible within a method.

GET {base_url}/api/v3/resellers/{reseller_id}/accounts

Arguments

Name

Parameter type

Data type

Required/Optional

Description

X-Api-TokenheaderstringRequiredAPI token of a manager that performs the operation (see Viewing and updating Manager's information)
Content-TypeheaderstringRequiredMedia type of the request. Specify the following: application/vnd.api+json
AcceptheaderstringRequired

Supported media types of the answer. Specify the following: application/vnd.api+json

base_urlpathstringRequiredActivePlatform URL
reseller_idpathnumberRequiredID of the current reseller or any of its downstream resellers (see Viewing and updating Reseller general information)
page[size]querynumberOptionalPage navigation: number of elements per page. The default value is 50
page[number]querynumberOptionalPage navigation: page number
filter[email]querystringOptionalFiltering by the email of the contract person. The parameter can be a comma-separated list
filter[user_email]querystringOptionalFiltering by the email of a user of the account. Requests the list of all attached accounts for the specified user
filter[inn]querystringOptionalFiltering by the Tax Identification Number of the account (in Russian, Идентификационный номер налогоплательщика, ИНН) specified in the inn account attribute (see Managing Attributes)
filter[created_at]querystringOptional

Filtering accounts by the date and time of the account creation in the RFC 3339 format (for example, 2019-05-29T15:12:01.558009+03:00 or 2019-05-29). To specify the period, the following filters are used:

  • filter[created_at][gt] — date and time are greater than the specified.
  • filter[created_at][lt] — date and time are less than the specified.
filter[updated_at]querystringOptional

Filtering accounts by the date and time of the account last update in the RFC 3339 format (for example, 2019-05-29T15:12:01.558009+03:00 or 2019-05-29). To specify the period, the following filters are used:

  • filter[updated_at][gt] — date and time are greater than the specified.
  • filter[updated_at][lt] — date and time are less than the specified.
includequerystringOptional

Returns additional information about objects related to accounts. The following objects and possible values are supported:

ObjectParameter value
Subscriptionsubscriptions

Response model

Name

Data type

Description

dataarray of objectsResponse data


id

string

Account ID

typestringData type

attributesobjectAccount information


created_at

string

Date and time of account creation


updated_at

string

Data and time of account last update


reseller_idnumberID of the account's reseller


namestringAccount name


account_class_idnumberAccount class ID


primary_namestringPrimary name of the account. For example, a company name


first_name

string

The first name of the contract person


middle_name

string

The middle name of the contract person


last_name

string

The last name of the contract person


countrystring

Contact information: a two-letter ISO code ISO 3166-1 alpha-2 of the country



regionstringContact information: Region


citystringContact information: City


streetstringContact information: Street


buildingstringContact information: Building


officestringContact information: Office


zipstringContact information: Zip-code


phonestring

Contact information: Phone number:

  • + < country code > < city code or network code > < phone number >.
  • 00 < country code > < city code or network code > < phone number >.


email

string

Email of the contract person


status

string

Account status (see Viewing and updating an Account's details for the list of statuses)



balancestringTotal account balance as a sum of available funds (see usable_balance) and blocked charges


usable_balancestringAvailable funds on the account balance


current_debt

numberCurrent debt of the account for all postpaid subscriptions


subscription_credit_limit

numberThe value of the subscription credit limit for the account that is set in the account class or redefined on the account level


financial_blocking_threshold

numberThe value of the financial blocking threshold for the account that is set in the account class or redefined on the account level


account_type_idnumberAccount type ID (см. Viewing the List of Account Types)


manager_idnumberAccount's manager ID


owner_idnumberAccount's Owner ID


tech_user_idnumber

ID of the account's user selected as Tech contact (see Viewing and updating an Account's details)



bill_user_idnumberID of the account's user selected as Billing contact (see Viewing and updating an Account's details)


custom_attributes

object

Account attributes (see Managing Attributes)




attributes.custom-attributes['custom-attribute-key']string

Account attribute value

For example, the Tax Identification Number of the account (in Russian, Идентификационный номер налогоплательщика, ИНН) is specified in the inn account attribute



managerobject

Information about the account's manager




created_atstringDate and time of the manager creation



updated_atstringData and time of the manager last update



reseller_idnumberID of the manager's reseller



idnumberID of the manager



namestringName of the manager



statusstring

Status of the manager:

  • active — access to the Operator Control Panel is allowed.
  • inactive — access to the Operator Control Panel is blocked.



emailstringManager's email which is used as a login to the Operator Control Panel



rolestringManager's role (for the list of roles, see Managers' Roles)



custom_attributesarrayThe list of the manager's additional attributes (see Viewing the List of Attributes)




manager.custom-attributes['custom-attribute-key']stringThe value of the attribute


ownerobjectinformation about the Owner of the account



created_at

stringDate and time of account's Owner creation



updated_at

stringDate and time of account's Owner last update



emailstringEmail of the account's Owner



account_statusstringAccount's Owner status for the account (for information about statues, see Managing Account's Users)



global_statusstringAccount's Owner status in ActivePlatform



first_namestringThe first name of the account's Owner



middle_namestringThe middle name of the account's Owner



last_namestringThe last name of the account's Owner


account_product_managersarray of objectsResponsible managers of the account (see Managing Responsible Managers)



idnumberID of information about the responsible manager



account_idnumberAccount ID



product_idnumberProduct ID



responsible_product_manager_idnumberResponsible manager ID within the product



manager_product_role_id

numberManager role ID within the product



created_at

stringDate and time when information about the responsible manager was created



updated_at

stringDate and time when information about the responsible manager was updated


self_registration

bool

Indicates whether the account was created by completing the self-registration process in the Customer Control Panel:

  • true — the account was created by completing the self-registration process in the Customer Control Panel.
  • false — the account was created by a manager via the Operator Control Panel or API.


default_payment_model

string

Default payment model:

  • prepay
  • postpay


account_typeobjectInformation about the account type (see Viewing the List of Account Types)



idnumberID of the account type



namestringName of the account type



created_atstringDate and time of the account type creation



updated_atstringDate and time when the account type was updated



reseller_idnumberID of the reseller linked to the account type



name_patternstringTemplate of the account type name which is displayed in the platform



primary_namestringName of the field with the primary name of the account. For example, for the Business account type, the filed may be named as Company name



keystringKey that is used to refer to the account type by API or a placeholder



default_payment_method_idnumberID of the default payment method (see Configuring Payment Methods)



ancestrystringID of the parent account type



used_by_defaultbool

Default account type for new accounts:

  • true — the account type is applied to new accounts.
  • false — the account type is not applied to new accounts.


account_classstringInformation about the account class (see Viewing the list of Account Classes)



idnumberID of the account class



reseller_idnumberID of the linked reseller



namestringName of the account class



created_atstringDate and time of the account type creation



updated_atstringDate and time when the account type was updated



financial_blocking_threshold

stringThe value of the financial blocking threshold that is set in the account class



due_order_periodnumberNumber of days to pay for an order before the order becomes canceled (for the prepay payment model)



subzero_periodnumberNumber of days during which the account balance can be negative without moving the account to the Credit hold status. The -1 value refers to the unlimited period



stop_subscription_typestringType of the subscription stopping if the account is moved to the Credit hold status (for the list of the available types of the subscription stopping, see Creating an Account Class)



keystring Key that is used to refer to the account class by API or placeholders



colorstringColor that is used in the List of accounts (see Viewing the List of Accounts) for this account type



guaranteed_payment_limitnumberMaximum amount of the guaranteed payment that all accounts, which are added to the account class, can use



guaranteed_payment_periodnumberNumber of days, during which all accounts, which are added to the account class, can use the Guaranteed payments



delete_subscription_typestringType of the subscription deleting (for the list of the available types of the subscription deleting, see Creating an Account Class)



denominatedbool

Attribute of the account type denomination:

  • true — the account type is denominated.
  • false — the account type is not denominated.



buy_with_negative_balancebool

Availability of paying for orders with the negative account balance (for the Prepay model):

  • true — paying for orders with the negative account balance is available.
  • false — paying for orders with the negative account balance is not available.



receipt_daynumberDeprecated



payment_modelstring

Payment model:

  • prepay
  • postpay



defaultbool

Default account class for new accounts:

  • true — the account type is applied to new accounts.
  • false — the account type is not applied to new accounts.



due_payment_periodnumberNumber of days to pay for a payment before the payment becomes expired (for the postpay payment model)



subscription_credit_limit

stringThe value of the subscription credit limit that is set in the account class

relationshipsobjectInformation about the related objects


subscriptionsobjectInformation about the related subscriptions



dataarrayInformation about the subscription




idstringID of the subscription




typestringData type
includedarray

Additional information about objects listed in the request:

NameData typeDescription
idintegerID of the object
typestringData type
attributesarrayAttributes of the object (see details below)

For a subscription:

NameData typeDescription

created_at

stringDate and time of subscription creation

updated_at

stringDate and time of subscription last update

auto_renewal

bool

Subscription auto-renewal attribute:

  • true — auto-renewal is set.
  • false — 

billing_from

stringBeginning date of the subscription paid period

expiration_date

stringSubscription expiration date

name

stringSubscription name

renew_point_days

numberRenew point (days)

start_date

stringSubscription activation date

status

stringSubscription status (see Viewing the list of Resellers Subscriptions for the list of subscription statuses)

payment_model

string

Subscription payment model:

  • prepay
  • postpay

payment_model_parameters

objectPayment model parameters

credit_limitnumberThe value of the subscription debt, above which the postpaid subscription will be stopped. For postpaid subscriptions only (payment_model = postpay)

current_debtnumberThe subscription debt that is calculated as the total amount of all blocked charges for the subscription for the current Billing period. For postpaid subscriptions only (payment_model = postpay)
linksobjectPage navigation links that use the defined page navigation parameters

selfstringCurrent page link

firststringFirst page link

prevstringPrevious page link

nextstringNext page link

laststringLast page link

Request example

GET /api/v3/resellers/1/accounts?page[size]=2&page[number]=1&filter[email]=test@example.com&include=subscriptions
Host: test.activeplatform.com
Content-Type: application/vnd.api+json
X-Api-Token: vY5fwetestK3gJXZH5uHCw
Accept: application/vnd.api+json

Response example

{
    "data": [
        {
            "id": "487",
            "type": "accounts",
            "attributes": {
                "created_at": "2019-08-19T15:10:43.222+03:00",
                "updated_at": "2019-08-19T15:16:49.990+03:00",
                "reseller_id": 1,
                "name": "Vit August",
                "account_class_id": 1,
                "primary_name": "",
                "first_name": "Vit ",
                "middle_name": "",
                "last_name": "August",
                "country": "US",
                "region": "NY",
                "city": "Brooklyn",
                "street": "Westminster ave.",
                "building": "",
                "office": "",
                "zip": "11230",
                "phone": "+16030000000",
                "email": "test@example.com",
                "status": "deleted",
                "balance": "0.0",
                "usable_balance": "0.0",
                "current_debt": 0,
                "subscription_credit_limit": 0,
                "financial_blocking_threshold": 100,
                "account_type_id": 1564,
                "manager_id": 223,
                "owner_id": 847,
                "tech_user_id": 847,
                "bill_user_id": 847,
                "custom_attributes": {
                    "inn": "00012345678"
                },
                "manager": {
                    "created_at": "2020-04-01T11:14:21.837+03:00",
                    "updated_at": "2019-12-30T14:40:31.322+03:00",
                    "reseller_id": 1,
                    "id": 223,
                    "name": "Bill Toss",
                    "status": "active",
                    "email": "manager@example.by",
                    "role": "sales",
                    "custom_attributes": {
                        "ManagerString": "Test"
                    }
                },
                "owner": {
                    "created_at": "2016-10-26T17:38:37.551+03:00",
                    "updated_at": "2016-12-23T15:04:48.172+03:00",
                    "email": "owner@example.by",
                    "account_status": "active",
                    "global_status": "active",
                    "first_name": "Alex",
                    "middle_name": "",
                    "last_name": "Owner"
                },
				"account_product_managers": [],
                "self_registration": false,
                "default_payment_model": "prepay",
                "account_type": {
                    "id": 1564,
                    "name": "FL",
                    "created_at": "2017-03-20T16:34:28.163+03:00",
                    "updated_at": "2017-03-20T16:34:28.163+03:00",
                    "reseller_id": 1,
                    "name_pattern": "%first_name %middle_name %last_name",
                    "primary_name": "",
                    "key": "personal",
                    "default_payment_method_id": null,
                    "ancestry": "1562",
                    "use_by_default": false
                },
                "account_class": {
                    "id": 1,
                    "reseller_id": 1,
                    "name": "Default",
                    "created_at": "2016-08-25T09:26:12.820+03:00",
                    "updated_at": "2019-10-27T10:58:46.758+03:00",
                    "financial_blocking_threshold": "100.0",
                    "due_order_period": 90,
                    "subzero_period": 1,
                    "stop_subscription_type": "automatically",
                    "key": "default",
                    "color": "grey",
                    "guaranteed_payment_limit": 1000,
                    "guaranteed_payment_period": 7,
                    "delete_subscription_type": "automatically",
                    "denominated": false,
                    "buy_with_negative_balance": false,
                    "receipt_day": null,
                    "payment_model": "prepay",
                    "default": true,
                    "due_payment_period": 30,
                    "subscription_credit_limit": "0.0"
                }
            },
            "relationships": {
                "subscriptions": {
                    "data": [
                        {
                            "id": "3005606",
                            "type": "subscriptions"
                        }
                    ]
                }
            }
        },
        {
            "id": "503",
            "type": "accounts",
            "attributes": {
                "created_at": "2019-08-22T15:59:53.492+03:00",
                "updated_at": "2019-09-20T10:50:27.033+03:00",
                "reseller_id": 1,
                "name": "Vit  Ada",
                "account_class_id": 1687,
                "primary_name": "DepV0304-4",
                "first_name": "Vit",
                "middle_name": "",
                "last_name": "Ada",
                "country": "TW",
                "region": "Moscow",
                "city": "Moscow",
                "street": "Line",
                "building": "",
                "office": "",
                "zip": "119002",
                "phone": "+74950000001",
                "email": "test@example.com",
                "status": "active",
                "balance": "-4.0",
                "usable_balance": "-4.0",
                "current_debt": 3,
                "subscription_credit_limit": 0,
                "financial_blocking_threshold": 10,
                "account_type_id": 1564,
                "manager_id": 223,
                "owner_id": 866,
                "tech_user_id": 866,
                "bill_user_id": 866,
                "custom_attributes": {},
                "manager": {
                    "created_at": "2020-04-01T11:14:21.837+03:00",
                    "updated_at": "2019-12-30T14:40:31.322+03:00",
                    "reseller_id": 1,
                    "id": 223,
                    "name": "Bill Toss",
                    "status": "active",
                    "email": "manager@example.by",
                    "role": "sales",
                    "custom_attributes": {
                        "ManagerString": "Test"
                    }
                },
                "owner": {
                    "created_at": "2016-10-26T17:38:37.551+03:00",
                    "updated_at": "2016-12-23T15:04:48.172+03:00",
                    "email": "owner@example.by",
                    "account_status": "active",
                    "global_status": "active",
                    "first_name": "Alex",
                    "middle_name": "",
                    "last_name": "Owner"
                },
				"account_product_managers": [],
                "self_registration": false,
                "default_payment_model": "prepay",
                "account_type": {
                    "id": 1564,
                    "name": "FL",
                    "created_at": "2017-03-20T16:34:28.163+03:00",
                    "updated_at": "2017-03-20T16:34:28.163+03:00",
                    "reseller_id": 1,
                    "name_pattern": "%first_name %middle_name %last_name",
                    "primary_name": "",
                    "key": "personal",
                    "default_payment_method_id": null,
                    "ancestry": "1562",
                    "use_by_default": false
                },
                "account_class": {
                    "id": 1687,
                    "reseller_id": 1,
                    "name": "Prepay",
                    "created_at": "2019-02-09T10:23:10.267+03:00",
                    "updated_at": "2019-09-20T10:48:33.157+03:00",
                    "financial_blocking_threshold": "10.0",
                    "due_order_period": 8,
                    "subzero_period": 1,
                    "stop_subscription_type": "automatically",
                    "key": "Prepay",
                    "color": "grey",
                    "guaranteed_payment_limit": 1000,
                    "guaranteed_payment_period": 7,
                    "delete_subscription_type": "automatically",
                    "denominated": false,
                    "buy_with_negative_balance": false,
                    "receipt_day": null,
                    "payment_model": "prepay",
                    "default": false,
                    "due_payment_period": 30,
                    "subscription_credit_limit": "0.0"
                }
            },
            "relationships": {
                "subscriptions": {
                    "data": [
                        {
                            "id": "3005649",
                            "type": "subscriptions"
                        }
                    ]
                }
            }
        }
    ],
    "included": [
        {
            "id": "3005606",
            "type": "subscriptions",
            "attributes": {
                "created_at": "2019-08-19T15:12:05.525024+0300",
                "updated_at": "2019-08-19T15:12:05.525024+0300",
                "auto_renewal": false,
                "billing_from": null,
                "expiration_date": null,
                "name": "Office USA monthly",
                "renew_point_days": 0,
                "start_date": null,
                "status": "deleted",
                "payment_model": "prepay",
                "payment_model_parameters": {}
            }
        },
        {
            "id": "3005649",
            "type": "subscriptions",
            "attributes": {
                "created_at": "2019-08-22T15:59:54.138703+0300",
                "updated_at": "2019-09-20T10:47:07.896382+0300",
                "auto_renewal": false,
                "billing_from": "2019-08-22",
                "expiration_date": "2019-12-22",
                "name": "Auto provisioning with resources",
                "renew_point_days": 1,
                "start_date": "2019-08-22",
                "status": "waiting_for_manual_approve",
                "payment_model": "postpay",
                "payment_model_parameters": {
                    "credit_limit": 0,
                    "current_debt": 3
                }
            }
        }
    ],
    "links": {
        "self": "https://test.activeplatform.com/api/v3/resellers/1/accounts?filter%5Bemail%5D=test%40example.com&include=subscriptions&page%5Bnumber%5D=1&page%5Bsize%5D=2",
        "first": "https://test.activeplatform.com/api/v3/resellers/1/accounts?filter%5Bemail%5D=test%40example.com&include=subscriptions&page%5Bnumber%5D=1&page%5Bsize%5D=2",
        "prev": null,
        "next": null,
        "last": "https://test.activeplatform.com/api/v3/resellers/1/accounts?filter%5Bemail%5D=test%40example.com&include=subscriptions&page%5Bnumber%5D=1&page%5Bsize%5D=2"
    }
}

Отзыв | Feedback