Получение списка аккаунтов

Метод используется для получения многостраничного списка неудаленных аккаунтов, к которым есть доступ у текущего пользователя.

Метод возвращает пустой ответ, если у пользователя нет доступа ни к одному аккаунту.

GET {reseller_domain}/internal_api/accounts

В этой статье:

Авторизация

Требуется авторизация с помощью access token пользователя.

Аргументы

Название	Тип параметра	Тип данных	Обязательный/ Опциональный	Описание
Content-Type	header	string	Обязательный	Тип данных, передаваемых в запросе. Укажите application/vnd.api+json
Accept	header	string	Обязательный	Поддерживаемые типы данных в ответе. Укажите application/vnd.api+json
X-Api-Locale	header	string	Опциональный	Двухбуквенный код языка данных в ответе
Authorization	header	string	Обязательный	Действующий access token пользователя. Формат: `Bearer <access token>`
reseller_domain	path	string	Обязательный	Доменное имя реселлера
page[size]	query	integer	Опциональный	Параметр постраничной навигации. Количество элементов на странице ответа (50 по умолчанию)
page[number]	query	integer	Опциональный	Параметр постраничной навигации. Номер страницы ответа (1 по умолчанию)
filter[full_name][like]	query	string	Опциональный	Предназначен для фильтрации списка по части ID и названия аккаунта без учета регистра
filter[status]	query	string	Опциональный	Предназначен для фильтрации списка по статусу аккаунта. Можно указать несколько значений через запятую. Доступные значения: active — Активен. credit_hold — Финансовая блокировка. inactive — Административная блокировка.
sort	query	string	Опциональный	Предназначен для сортировки элементов списка по указанному параметру. Доступные значения: sort=created_at — сортировка по возрастанию значений `created_at`. sort=-created_at — сортировка по убыванию значений `created_at`.

Модель ответа

Название					Тип данных	Описание
data					array of objects	Данные ответа
	id				string	ID аккаунта
	type				string	Тип данных
	attributes				object	Информация об аккаунте
		created_at			string	Дата и время создания аккаунта
		name			string	Название аккаунта для отображения в Панели управления Клиента по шаблону типа аккаунта (подробнее см. )
		primary_name			string	Основное имя аккаунта. Например, название компании для юридического лица
		status			string	Статус аккаунта (см. ): active — Активен. credit_hold — Финансовая блокировка. inactive — Административная блокировка.
		user_status			string	Статус пользователя в аккаунте: active — Активный. inactive — Неактивный.
		user_role			string	Уровень доступа пользователя в аккаунте (подробнее см. ): owner — Владелец. admin — Администратор. finance — Финансовый менеджер. user — Пользователь.
		trial			bool	Признак клиента, который заказал пробную подписку без полной регистрации: true — клиент заказал пробную подписку без полной регистрации аккаунта. Недоступно в текущей версии. false — клиент заказал пробную подписку и указал все контактные данные аккаунта.
		account_type			object	Информация о типе аккаунта (см. )
			id		integer	ID типа аккаунта
			key		string	Ключ типа аккаунта
			name		string	Название типа аккаунта
		terms_and_conditions			object	Информация о принятии аккаунтом соглашения Правила продаж (см. Согласие с общими условиями работы в Соглашения с клиентами в ). См. также Получение информации о соглашениях аккаунта
			confirmed		bool	Признак принятия соглашения: true — аккаунт принял соглашение. false — соглашение не принято.
			url		string	Ссылка на правила продаж
		microsoft_customer_agreement			object	Информация о принятии аккаунтом Клиентского соглашения Microsoft (см. пример в в руководстве Услуги. Документация Оператора). См. также Получение информации о соглашениях аккаунта
			confirmed		bool	Признак принятия соглашения: true — аккаунт принял соглашение. false — соглашение не принято.
			url		string	Ссылка на клиентское соглашение Microsoft
		usable_balance			number	Свободные средства на балансе аккаунта
		reseller_currency_iso_code			string	Код валюты реселлера
		account_class			object	Информация о правиле обслуживания аккаунта (см. )
			id		integer	ID правила обслуживания
			key		string	Ключ правила обслуживания
			name		string	Название правила обслуживания
			payment_model		string	Модель оплаты по умолчанию — используется для подписок, заказанных через Панель управления Клиента: prepay — Предоплата. postpay — Постоплата.
			buy_with_negative_balance		bool	Признак Оплата с отрицательным балансом (см. ): true — аккаунт может оплачивать услуги, имея отрицательный баланс. false — аккаунт не может оплачивать услуги, имея отрицательный баланс.
			guaranteed_payment_limit		integer	Максимальная сумма обещанного платежа
			guaranteed_payment_period		integer	Количество дней, в течение которых аккаунт может использовать обещанный платеж
		financial_blocking_threshold			number	Порог срабатывания финансовой блокировки
		finance_lock_date			string	Ожидаемая дата начала финансовой блокировки, исходя из разрешенного периода отрицательного баланса — только для активного аккаунта с отрицательным балансом
		current_consumption			number	Текущее потребление аккаунта как сумма следующих величин (см. ): Сумма, заблокированная на балансе аккаунта. Текущая задолженность.
		user_contract			object	Информация о лице, уполномоченном на заключение договора
			last_name		string	Фамилия уполномоченного лица
			first_name		string	Имя уполномоченного лица
			middle_name		string	Отчество уполномоченного лица
			email		string	Email уполномоченного лица
		contact_data			object	Адресная информация аккаунта
			country		string	Код страны
			zip		string	Почтовый индекс
			region		string	Регион (Область)
			city		string	Город
			street		string	Улица
			building		string	Дом
			office		string	Офис
			phone		string	Номер телефона
		contact_users			object	Информация о контактных лицах (см. )
			main		object	Информация об основном контактном лице (Владельце аккаунта)
				id	integer	ID пользователя
				last_name	string	Фамилия пользователя
				first_name	string	Имя пользователя
				middle_name	string	Отчество пользователя
				email	string	Email пользователя
			tech		object	Информация о контактном лице по техническим вопросам
				id	integer	ID пользователя
				last_name	string	Фамилия пользователя
				first_name	string	Имя пользователя
				middle_name	string	Отчество пользователя
				email	string	Email пользователя
			bill		object	Информация о контактном лице по финансовым вопросам
				id	integer	ID пользователя
				last_name	string	Фамилия пользователя
				first_name	string	Имя пользователя
				middle_name	string	Отчество пользователя
				email	string	Email пользователя
		custom_attributes			object	Список пар ключ-значение дополнительных атрибутов аккаунта (см. )
		manager			object	Информация о менеджере аккаунта
			name		string	Полное имя менеджера
			email		string	Email менеджера
			photo		string	Ссылка на фото менеджера
		available_operations			object	Список действий, доступных для аккаунта с учетом его статуса и настроек реселлера (см. Получение настроек реселлера )
			join_payments		bool	Возможность объединять платежи вручную: true — действие доступно. false — действие недоступно.
			top_up_balance		bool	Возможность пополнять баланс: true — действие доступно. false — действие недоступно.
			create_guaranteed_payment		bool	Возможность создавать обещанные платежи: true — действие доступно. false — действие недоступно.
			invite_user		bool	Возможность приглашать пользователей (см. Приглашенные пользователи): true — действие доступно. false — действие недоступно.
		work_permit_for_postpaid			string	Наличие у аккаунта разрешения на заказ подписок по модели Постоплата (см. ): approved — менеджер разрешил аккаунту заказывать подписки на коммерческий период по модели Постоплата. approval required — аккаунт попытался заказать первую подписку на коммерческий период по модели Постоплата в период, когда для этого требовалось ручное подтверждение менеджера. Аккаунт находится на рассмотрении у менеджера. declined — менеджер запретил аккаунту заказывать подписки на коммерческий период по модели Постоплата. verification not performed — аккаунт не заказывал подписки на коммерческий период по модели Постоплата в период, когда для этого требовалось ручное подтверждение менеджера.
		mfa_required			bool	Признак обязательности использования MFA всеми пользователями аккаунта: true — использование MFA является обязательным для всех пользователей аккаунта. false — использование MFA является необязательным для всех пользователей аккаунта.
links					object	Ссылки для постраничной навигации
	self				string	Текущая страница
	first				string	Первая страница
	prev				string	Предыдущая страница (при наличии)
	next				string	Следующая страница (при наличии)
	last				string	Последняя страница
meta					object	Дополнительная информация
	current_page				integer	Номер текущей страницы
	page_count				integer	Общее число страниц
	server_current_time				string	Текущие дата и время сервера

Пример запроса

Bash

curl --location --request GET 'https://test.activeplatform.com/internal_api/accounts' \
--header 'Content-Type: application/vnd.api+json' \
--header 'Accept: application/vnd.api+json' \
--header 'X-Api-Locale: en' \
--header 'Authorization: Bearer AccessTokenExample'

Пример ответа

JSON

{
    "data": [
        {
            "id": "1185",
            "type": "accounts",
            "attributes": {
                "created_at": "2020-10-05 T09:38:44.590785+0300",
                "name": "First Account",
                "primary_name": "",
                "status": "active",
                "user_status": "active",
                "user_role": "admin",
                "trial": false,
                "account_type": {
                    "id": 1562,
                    "key": "personal",
                    "name": "Personal"
                },
                "terms_and_conditions": {
                    "confirmed": true,
                    "url": "https://test.activeplatform.com/terms"
                },
                "microsoft_customer_agreement": {
                    "confirmed": true,
                    "url": "https://test.activeplatform.com/mca"
                },
                "usable_balance": 125000.0,
                "reseller_currency_iso_code": "USD",
                "account_class": {
                    "id": 2712,
                    "key": "postpay",
                    "name": "Postpay",
                    "payment_model": "postpay",
                    "buy_with_negative_balance": true,
                    "guaranteed_payment_limit": 1000,
                    "guaranteed_payment_period": 7
                },
                "financial_blocking_threshold": 200.0,
                "finance_lock_date": null,
                "current_consumption": 0.0,
                "user_contract": {
                    "last_name": "Frederick",
                    "first_name": "Kunze",
                    "middle_name": "",
                    "email": "Tyra78@example.org"
                },
                "contact_data": {
                    "country": "BY",
                    "zip": "220100",
                    "region": "Minsk",
                    "city": "Minsk",
                    "street": "Main",
                    "building": "1",
                    "office": "",
                    "phone": "+375999999999"
                },
                "contact_users": {
                    "main": {
                        "id": 1650,
                        "last_name": "Oberbrunner",
                        "first_name": "Minerva",
                        "middle_name": "",
                        "email": "Devante77@example.org"
                    },
                    "tech": {
                        "id": 1650,
                        "last_name": "Oberbrunner",
                        "first_name": "Minerva",
                        "middle_name": "",
                        "email": "Devante77@example.org"
                    },
                    "bill": {
                        "id": 1650,
                        "last_name": "Oberbrunner",
                        "first_name": "Minerva",
                        "middle_name": "",
                        "email": "Devante77@example.org"
                    }
                },
                "custom_attributes": {
                    "bank_account": "2300000000000",
                    "invoice": true,
                    "vendor_ccp": ""
                },
                "manager": {
                    "name": "Christa Gislason",
                    "email": "Samanta.Shanahan76@example.org",
                    "photo": null
                },
                "available_operations": {
                    "join_payments": true,
                    "top_up_balance": true,
                    "create_guaranteed_payment": true,
                    "invite_user": true
                },
                "work_permit_for_postpaid": "verification_not_performed",
                "mfa_required": false
            }
        },
        {
            "id": "1680",
            "type": "accounts",
            "attributes": {
                "created_at": "2022-01-13 T11:58:49.893191+0300",
                "name": "Second Account",
                "primary_name": "Second Account",
                "status": "credit_hold",
                "user_status": "active",
                "user_role": "finance",
                "trial": false,
                "account_type": {
                    "id": 2,
                    "key": "business__no_vat",
                    "name": "Business"
                },
                "terms_and_conditions": {
                    "confirmed": true,
                    "url": "https://test.activeplatform.com/terms"
                },
                "microsoft_customer_agreement": {
                    "confirmed": true,
                    "url": "https://test.activeplatform.com/mca"
                },
                "usable_balance": -3.75,
                "reseller_currency_iso_code": "USD",
                "account_class": {
                    "id": 3761,
                    "key": "prepay",
                    "name": "Prepay",
                    "payment_model": "prepay",
                    "buy_with_negative_balance": false,
                    "guaranteed_payment_limit": 300,
                    "guaranteed_payment_period": 7
                },
                "financial_blocking_threshold": 0.0,
                "finance_lock_date": null,
                "current_consumption": 0.0,
                "user_contract": {
                    "last_name": "Dallas",
                    "first_name": "Kenneth",
                    "middle_name": "",
                    "email": "Alexys5@example.net"
                },
                "contact_data": {
                    "country": "BY",
                    "zip": "220021",
                    "region": "Minsk",
                    "city": "Minsk",
                    "street": "Nemiga",
                    "building": "",
                    "office": "",
                    "phone": "+375290000000"
                },
                "contact_users": {
                    "main": {
                        "id": 2226,
                        "last_name": "Jaden",
                        "first_name": "Hammes",
                        "middle_name": "",
                        "email": "Helene13@example.net"
                    },
                    "tech": {
                        "id": 2226,
                        "last_name": "Jaden",
                        "first_name": "Hammes",
                        "middle_name": "",
                        "email": "Helene13@example.net"
                    },
                    "bill": {
                        "id": 2226,
                        "last_name": "Jaden",
                        "first_name": "Hammes",
                        "middle_name": "",
                        "email": "Helene13@example.net"
                    }
                },
                "custom_attributes": {
                    "bank_account": "3200000000000",
                    "invoice": false,
                    "vendor_ccp": ""
                },
                "manager": null,
                "available_operations": {
                    "join_payments": true,
                    "top_up_balance": true,
                    "create_guaranteed_payment": true,
                    "invite_user": true
                },
                "work_permit_for_postpaid": "verification_not_performed",
                "mfa_required": false
            }
        }
    ],
    "links": {
        "self": "https://test.activeplatform.com/internal_api/accounts?page%5Bnumber%5D=1&page%5Bsize%5D=50",
        "first": "https://test.activeplatform.com/internal_api/accounts?page%5Bnumber%5D=1&page%5Bsize%5D=50",
        "prev": null,
        "next": null,
        "last": "https://test.activeplatform.com/internal_api/accounts?page%5Bnumber%5D=1&page%5Bsize%5D=50"
    },
    "meta": {
        "current_page": 1,
        "page_count": 1,
        "server_current_time": "2023-06-30 T12:34:56.199973+0300"
    }
}