API

Отримати список push-сповіщень

GET/api/crm/v2/push_notificationsv2
operationId: pushNotifications.default

Авторизація

api-token + language + role

Параметри запиту

date_creation_fromstring

Приклад: 25/04/2024

date_creation_tostring

Приклад: 26/04/2024

chain_idinteger

Приклад: 7124

branch_idinteger
page_numberinteger

Приклад: 1

Відповіді

OK

object
statusstringобов’язковий

Значення:successerror

Приклад: success

dataobject
filtersobject
date_creation_fromobject (FilterDateFrom)
valuestringможе бути null

Приклад: 2026-08-01 00:00:00

typestringобов’язковий

Приклад: date

modestring (FilterMode)

Як інтерфейс обробляє фільтр; у звичайного фільтра mode немає. force_shown — завжди відображається, приховати не можна. value_required — точка входу в розділ: завжди відображається, не має порожнього значення (поки значення не вибрано, список порожній; варіанту «всі» немає), загальне скидання його не очищає.

Значення:force_shownvalue_required

Приклад: value_required

date_creation_toobject (FilterDateTo)
valuestringможе бути null

Приклад: 2026-08-31 23:59:59

typestringобов’язковий

Приклад: date

modestring (FilterMode)

Як інтерфейс обробляє фільтр; у звичайного фільтра mode немає. force_shown — завжди відображається, приховати не можна. value_required — точка входу в розділ: завжди відображається, не має порожнього значення (поки значення не вибрано, список порожній; варіанту «всі» немає), загальне скидання його не очищає.

Значення:force_shownvalue_required

Приклад: value_required

date_creation_rangeobject (FilterDateRange)

Готові періоди фільтра за датою; нижня межа розраховується у часовому поясі користувача. value — період, якому відповідають поточні *_from та *_to; null — довільний період. default — період, який сервер підставляє у запит без дат: також застосовується при першому завантаженні розділу та при скиданні. Верхня межа періоду завжди дорівнює поточному дню користувача, тому option її не містить: передавати *_to для готового періоду не потрібно, сервер встановлює її самостійно. Період довший за рік обрізається зі сторони новішої межі.

valuestring (DateRange) може бути null

Готовий період фільтра за датою. Власного параметра запиту не має: нижня межа вже розрахована в option і підставляється в *_from. Верхня межа не передається ні у відповіді, ні у запиті — вона завжди дорівнює поточному дню користувача і задається сервером.

Значення:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Приклад: today

defaultstring (DateRange) обов’язковий

Готовий період фільтра за датою. Власного параметра запиту не має: нижня межа вже розрахована в option і підставляється в *_from. Верхня межа не передається ні у відповіді, ні у запиті — вона завжди дорівнює поточному дню користувача і задається сервером.

Значення:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Приклад: today

typestringобов’язковий

Приклад: select

modestring (FilterMode)

Як інтерфейс обробляє фільтр; у звичайного фільтра mode немає. force_shown — завжди відображається, приховати не можна. value_required — точка входу в розділ: завжди відображається, не має порожнього значення (поки значення не вибрано, список порожній; варіанту «всі» немає), загальне скидання його не очищає.

Значення:force_shownvalue_required

Приклад: value_required

optionarray of objectобов’язковий
valuestring (DateRange) обов’язковий

Готовий період фільтра за датою. Власного параметра запиту не має: нижня межа вже розрахована в option і підставляється в *_from. Верхня межа не передається ні у відповіді, ні у запиті — вона завжди дорівнює поточному дню користувача і задається сервером.

Значення:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Приклад: today

date_fromstringобов’язковий

Приклад: 25/08/2026

branch_idobject (FilterSelectInteger)
valueinteger

Приклад: 8920

typestringобов’язковий

Приклад: select

optionarray of object
valueintegerобов’язковий

Приклад: 8920

namestringобов’язковий

Приклад: Green Basket | Kaliningrad

modestring (FilterMode)

Як інтерфейс обробляє фільтр; у звичайного фільтра mode немає. force_shown — завжди відображається, приховати не можна. value_required — точка входу в розділ: завжди відображається, не має порожнього значення (поки значення не вибрано, список порожній; варіанту «всі» немає), загальне скидання його не очищає.

Значення:force_shownvalue_required

Приклад: value_required

firms_prices_pushnumber

Приклад: 0.06

holiday_datesarray of string
listarray of object
idintegerобов’язковий

Приклад: 1

statusstring (StatusPushNotifications) обов’язковий

Значення:in_queuerunsuccesserrorend_with_error

Приклад: in_queue

branch_idintegerобов’язковий

Приклад: 1

titlestring

Приклад: title

ios_successintegerобов’язковий

Приклад: 0

ios_failureintegerобов’язковий

Приклад: 0

android_successintegerобов’язковий

Приклад: 0

android_failureintegerобов’язковий

Приклад: 0

site_successintegerобов’язковий

Приклад: 0

site_failureintegerобов’язковий

Приклад: 0

price_onenumberобов’язковий

Приклад: 0

messagestringобов’язковий

Приклад: Lorem Ipsum is simply dummy text of the printing and typesetting industry

platformstring (Platform) обов’язковий

Значення:androidiosallmobile_appssitesocial_apps

Приклад: all

genderstring (Gender)

Значення:womanman

Приклад: man

date_of_birth_fromstring

Приклад: 09/07

date_of_birth_tostring

Приклад: 10/07

date_creationstring (DataTimeFormatSQL) обов’язковий

Приклад: 2024-05-02 08:31:16

date_sendingstring (DataTimeFormatSQL) обов’язковий

Приклад: 2024-05-02 08:31:16

date_last_order_fromstring (DataTimeFormatSQL)

Приклад: 2024-05-02 08:31:16

date_last_order_tostring (DataTimeFormatSQL)

Приклад: 2024-05-02 08:31:16

namestringобов’язковий

Назва мережі

Приклад: Green Basket

city_namestringобов’язковий

Приклад: Voronezh

sumnumber

Вартість push-сповіщення

Приклад: 0

paginationobject (Pagination)
max_countintegerобов’язковий

Кількість елементів на сторінці

Приклад: 30

page_numberintegerобов’язковий

Номер поточноï сторінки; обмежено так, щоб зсув не перевищував 1000

Приклад: 1

has_nextbooleanобов’язковий

Чи є наступна сторінка

Приклад: true

has_previousbooleanобов’язковий

Чи є попередня сторінка

Приклад: false