Получение списка email-уведомлений

Метод используется для получения многостраничного списка email-уведомлений текущего пользователя. Метод возвращает все уведомления, отправленные на email текущего пользователя (email-уведомления в статусе Завершен, см. ), без разделения по его аккаунтам.

GET {reseller_domain}/internal_api/email_notifications

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

Авторизация

Требуется авторизация с помощью 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 по умолчанию)
sort	query	string	Опциональный	Предназначен для сортировки элементов списка по указанному параметру. Доступные значения: sort=created_at — сортировка по возрастанию значений `created_at`. sort=-created_at — сортировка по убыванию значений `created_at`.

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

Название			Тип данных	Описание
data			array of objects	Данные ответа
	id		string	ID email-уведомления
	type		string	Тип данных
	attributes		object	Информация об email-уведомлении
		created_at	string	Дата и время создания email-уведомления
		subject	string	Тема email-уведомления
		body	string	Содержимое 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/email_notifications' \
--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": "454251",
            "type": "notification_log_emails",
            "attributes": {
                "created_at": "2023-01-05T15:22:33.373917+0300",
                "subject": "Confirm email",
                "body": "..."
            }
        },
        {
            "id": "454252",
            "type": "notification_log_emails",
            "attributes": {
                "created_at": "2023-01-05T15:25:19.656118+0300",
                "subject": "Welcome to ActivePlatform",
                "body": "..."
            }
        }
    ],
    "links": {
        "self": "https://test.activeplatform.com/internal_api/email_notifications?page%5Bnumber%5D=1&page%5Bsize%5D=50",
        "first": "https://test.activeplatform.com/internal_api/email_notifications?page%5Bnumber%5D=1&page%5Bsize%5D=50",
        "prev": null,
        "next": null,
        "last": "https://test.activeplatform.com/internal_api/email_notifications?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"
    }
}