Breadcrumbs

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

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

GET {reseller_domain}/internal_api/accounts/{account_id}/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 по умолчанию)

filter[full_name][like]

query

string

Опциональный

Предназначен для фильтрации списка по части ФИО пользователя без учета регистра

filter[status]

query

string

Опциональный

Предназначен для фильтрации списка по статусу пользователя. Доступные значения:

  • active — Активный.

  • inactive — Неактивный.

filter[role]

query

string

Опциональный

Предназначен для фильтрации списка по уровню доступа пользователя. Доступные значения (подробнее см. ):

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

Дата и время создания пользователя



first_name

string

Имя пользователя



middle_name

string

Отчество пользователя



last_name

string

Фамилия пользователя



status_for_account

string

Статус пользователя в указанном аккаунте:

  • active — Активный.

  • inactive — Неактивный.



role_for_account

string

Уровень доступа в указанном аккаунте (подробнее см. ):



email

string

Email пользователя, который используется как логин для входа в Панель управления Клиента



custom_attributes

object

Список пар ключ-значение дополнительных атрибутов пользователя (см.

Получение списка атрибутов пользователя

)

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/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": "1650",
            "type": "users",
            "attributes": {
                "created_at": "2020-10-05T09:38:43.839891+0300",
                "first_name": "Carren",
                "middle_name": "",
                "last_name": "Bealow",
                "status_for_account": "active",
                "role_for_account": "owner",
                "email": "owner@example.com",
                "custom_attributes": {
                    "text": "",
                    "date": "2022-11-17",
                    "list_user": {
                        "key": "one",
                        "name": "First"
                    },
                    "check": false
                }
            }
        },
        {
            "id": "2477",
            "type": "users",
            "attributes": {
                "created_at": "2023-01-05T15:22:32.906293+0300",
                "first_name": "Kristopher",
                "middle_name": "Herbert",
                "last_name": "Legros",
                "status_for_account": "active",
                "role_for_account": "admin",
                "email": "admin@example.com",
                "custom_attributes": {
                    "text": "",
                    "date": "2023-01-13",
                    "list_user": null,
                    "check": false
                }
            }
        },
        {
            "id": "2478",
            "type": "users",
            "attributes": {
                "created_at": "2023-01-05T17:01:36.737743+0300",
                "first_name": "Horacio",
                "middle_name": "",
                "last_name": "Swaniawski",
                "status_for_account": "active",
                "role_for_account": "finance",
                "email": "fin@example.org",
                "custom_attributes": null
            }
        },
        {
            "id": "2479",
            "type": "users",
            "attributes": {
                "created_at": "2023-01-05T17:50:18.925604+0300",
                "first_name": "Eloisa",
                "middle_name": "",
                "last_name": "Carroll",
                "status_for_account": "inactive",
                "role_for_account": "user",
                "email": "user76@example.com",
                "custom_attributes": null
            }
        }
    ],
    "links": {
        "self": "https://test.activeplatform.com/internal_api/accounts/1185/users?page%5Bnumber%5D=1&page%5Bsize%5D=50",
        "first": "https://test.activeplatform.com/internal_api/accounts/1185/users?page%5Bnumber%5D=1&page%5Bsize%5D=50",
        "prev": null,
        "next": null,
        "last": "https://test.activeplatform.com/internal_api/accounts/1185/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"
    }
}