API

Get a list of push notifications

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

Authorization

api-token + language + role

Query parameters

date_creation_fromstring

Example: 25/04/2024

date_creation_tostring

Example: 26/04/2024

chain_idinteger

Example: 7124

branch_idinteger
page_numberinteger

Example: 1

Responses

OK

object
statusstringrequired

Values:successerror

Example: success

dataobject
filtersobject
date_creation_fromobject (FilterDateFrom)
valuestringcan be null

Example: 2026-08-01 00:00:00

typestringrequired

Example: date

modestring (FilterMode)

How the interface handles the filter; a regular filter does not have mode.
force_shown — always displayed, cannot be hidden.
value_required — entry point to the section: always displayed, cannot have an empty value (until a value is selected, the list is empty; there is no "all" option), global reset does not clear it.

Values:force_shownvalue_required

Example: value_required

date_creation_toobject (FilterDateTo)
valuestringcan be null

Example: 2026-08-31 23:59:59

typestringrequired

Example: date

modestring (FilterMode)

How the interface handles the filter; a regular filter does not have mode.
force_shown — always displayed, cannot be hidden.
value_required — entry point to the section: always displayed, cannot have an empty value (until a value is selected, the list is empty; there is no "all" option), global reset does not clear it.

Values:force_shownvalue_required

Example: value_required

date_creation_rangeobject (FilterDateRange)

Predefined date filter ranges; the lower boundary is calculated in the user's timezone. value is the range corresponding to the current *_from and *_to; null means a custom range. default is the range the server uses when a request has no dates: it is also applied on the first section load and when resetting. The upper boundary of the range always matches the user's current day, so option does not include it: you do not need to send *_to for a predefined range, the server sets it automatically. Ranges longer than one year are trimmed from the most recent boundary.

valuestring (DateRange) can be null

Predefined date filter range. It does not have its own query parameter: the lower boundary is pre-calculated in option and is used as *_from. The upper boundary is neither returned in the response nor sent in the request—it is always set to the user's current day by the server.

Values:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Example: today

defaultstring (DateRange) required

Predefined date filter range. It does not have its own query parameter: the lower boundary is pre-calculated in option and is used as *_from. The upper boundary is neither returned in the response nor sent in the request—it is always set to the user's current day by the server.

Values:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Example: today

typestringrequired

Example: select

modestring (FilterMode)

How the interface handles the filter; a regular filter does not have mode.
force_shown — always displayed, cannot be hidden.
value_required — entry point to the section: always displayed, cannot have an empty value (until a value is selected, the list is empty; there is no "all" option), global reset does not clear it.

Values:force_shownvalue_required

Example: value_required

optionarray of objectrequired
valuestring (DateRange) required

Predefined date filter range. It does not have its own query parameter: the lower boundary is pre-calculated in option and is used as *_from. The upper boundary is neither returned in the response nor sent in the request—it is always set to the user's current day by the server.

Values:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Example: today

date_fromstringrequired

Example: 25/08/2026

branch_idobject (FilterSelectInteger)
valueinteger

Example: 8920

typestringrequired

Example: select

optionarray of object
valueintegerrequired

Example: 8920

namestringrequired

Example: Green Basket | Kaliningrad

modestring (FilterMode)

How the interface handles the filter; a regular filter does not have mode.
force_shown — always displayed, cannot be hidden.
value_required — entry point to the section: always displayed, cannot have an empty value (until a value is selected, the list is empty; there is no "all" option), global reset does not clear it.

Values:force_shownvalue_required

Example: value_required

firms_prices_pushnumber

Example: 0.06

holiday_datesarray of string
listarray of object
idintegerrequired

Example: 1

statusstring (StatusPushNotifications) required

Values:in_queuerunsuccesserrorend_with_error

Example: in_queue

branch_idintegerrequired

Example: 1

titlestring

Example: title

ios_successintegerrequired

Example: 0

ios_failureintegerrequired

Example: 0

android_successintegerrequired

Example: 0

android_failureintegerrequired

Example: 0

site_successintegerrequired

Example: 0

site_failureintegerrequired

Example: 0

price_onenumberrequired

Example: 0

messagestringrequired

Example: Lorem Ipsum is simply dummy text of the printing and typesetting industry

platformstring (Platform) required

Values:androidiosallmobile_appssitesocial_apps

Example: all

genderstring (Gender)

Values:womanman

Example: man

date_of_birth_fromstring

Example: 09/07

date_of_birth_tostring

Example: 10/07

date_creationstring (DataTimeFormatSQL) required

Example: 2024-05-02 08:31:16

date_sendingstring (DataTimeFormatSQL) required

Example: 2024-05-02 08:31:16

date_last_order_fromstring (DataTimeFormatSQL)

Example: 2024-05-02 08:31:16

date_last_order_tostring (DataTimeFormatSQL)

Example: 2024-05-02 08:31:16

namestringrequired

Network name

Example: Green Basket

city_namestringrequired

Example: Voronezh

sumnumber

Push notification cost

Example: 0

paginationobject (Pagination)
max_countintegerrequired

Number of items per page

Example: 30

page_numberintegerrequired

Current page number; limited so that the offset does not exceed 1000

Example: 1

has_nextbooleanrequired

Is there a next page

Example: true

has_previousbooleanrequired

Is there a previous page

Example: false