Получение списка приглашенных пользователей

Метод используется для получения многостраничного списка приглашенных пользователей аккаунта. В ответ включаются только приглашенных пользователи в статусе Активный, т.е. только те, кто еще не принял приглашение и оно еще не отозвано. У текущего пользователя должен быть доступ к указанному аккаунту.

GET {reseller_domain}/internal_api/accounts/{account_id}/invited_users

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

Авторизация

Требуется авторизация с помощью 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	Обязательный	Доменное имя реселлера
account_id	path	integer	Обязательный	ID аккаунта, для которого запрашивается список пользователей
page[size]	query	integer	Опциональный	Параметр постраничной навигации. Количество элементов на странице ответа (50 по умолчанию)
page[number]	query	integer	Опциональный	Параметр постраничной навигации. Номер страницы ответа (1 по умолчанию)

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

Название			Тип данных	Описание
data			array of objects	Данные ответа
	id		string	ID приглашенного пользователя
	type		string	Тип данных
	attributes		object	Информация о приглашенном пользователе
		account_id	integer	ID аккаунта, от имени которого отправлено приглашение
		status	string	Статус приглашенного пользователя: active — Активный. Приглашение пользователя не использовано и не отозвано. inactive — Неактивный. Приглашение пользователя было использовано или отозвано. В ответ включаются только приглашенные пользователи, у которых `status = active`
		token	string	Токен-приглашение присоединиться к указанному аккаунту
		role	string	Уровень доступа в рамках указанного аккаунта, который будет назначен приглашенному пользователю (подробнее см. ): admin — Администратор. technical_manager — Технический менеджер. finance — Финансовый менеджер. user — Пользователь.
		email	string	Email, на который отправлено приглашение и который будет использоваться как логин для входа в Панель управления Клиента
		invite_date	string	Дата и время создания приглашения (см. Приглашение пользователя )
		action	string	Параметр страницы входа при принятии приглашения: sign_up — регистрация. У реселлера нет пользователя клиента с указанным email. Чтобы присоединиться к аккаунту, пользователю нужно будет пройти быструю регистрацию. sign_in — вход. У реселлера есть пользователь клиента с указанным email.
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/1185/invited_users' \
--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": "294",
            "type": "invited_users",
            "attributes": {
                "account_id": 1185,
                "status": "active",
                "token": "InviteTokenExample1",
                "role": "admin",
                "email": "user1@example.com",
                "invite_date": "2023-01-16T10:00:47.261628+0300",
                "action": "sign_up"
            }
        },
        {
            "id": "295",
            "type": "invited_users",
            "attributes": {
                "account_id": 1185,
                "status": "active",
                "token": "InviteTokenExample2",
                "role": "finance",
                "email": "user2@example.com",
                "invite_date": "2023-01-16T10:00:59.858819+0300",
                "action": "sign_up"
            }
        }
    ],
    "links": {
        "self": "https://test.activeplatform.com/internal_api/accounts/1185/invited_users?page%5Bnumber%5D=1&page%5Bsize%5D=50",
        "first": "https://test.activeplatform.com/internal_api/accounts/1185/invited_users?page%5Bnumber%5D=1&page%5Bsize%5D=50",
        "prev": null,
        "next": null,
        "last": "https://test.activeplatform.com/internal_api/accounts/1185/invited_users?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"
    }
}