Список підписок

Отримати всі підписки

get

/tracking-push/subscribers

Отримати список усіх підписок, пов’язаних із клієнтом.

Authorizations

AuthorizationstringRequired

Авторизаційний JWT-токен із терміном дії 1 година в заголовку

Query parameters

pageintegerOptional

Номер сторінки, яку необхідно повернути.

Example: 1

limitintegerOptional

Максимальна кількість елементів, що повертаються на сторінці.

Example: 10

Responses

200

Успішна відповідь, що містить список підписок.

application/json

current_pageintegerOptional

Поточна сторінка набору результатів із пагінацією.

Example: 1

last_pageintegerOptional

Остання сторінка набору результатів із пагінацією.

Example: 1

per_pageintegerOptional

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

Example: 15

totalintegerOptional

Загальна кількість доступних підписок.

Example: 1

401

Unauthorized

application/json

404

The specified resource was not found

application/json

422

Validation error

application/json

503

Connection time-out

application/json

get/tracking-push/subscribers

GET /v.1.0/tracking-push/subscribers HTTP/1.1
Host: api-stage.novapost.com/
Authorization: YOUR_API_KEY
Accept: */*

{
  "current_page": 1,
  "last_page": 1,
  "per_page": 15,
  "total": 3,
  "items": [
    {
      "id": "a47388e8-2af0-447e-a33b-1484b79b6331",
      "type": "numbers",
      "url": "https://api.somehost.link/endpoint",
      "isActive": true,
      "phone": "",
      "cid": "11a111a1-a1a1-11aa-a111-111111aa1111",
      "eventTypes": [
        "ReadyToShip"
      ],
      "sendWarnings": true,
      "warningEmail": "[e-mail]",
      "sendFullHistoryForMultiParcel": false,
      "contentType": "application/json",
      "companyTins": [],
      "secretToken": "k4MzM1NywiZXhwIjoxNzM3",
      "secretTokenHeaderName": null,
      "updatedAt": "2025-04-14T07:26:20.994000Z",
      "createdAt": "2025-04-14T07:26:20.994000Z",
      "numbers": []
    }
  ]
}

Застарілі параметри

Частина параметрів дублюється у snake_case-написанні. Ці параметри збережено виключно для забезпечення зворотної сумісності — для нових інтеграцій використовуйте варіанти в camelCase.

Застарілий параметр	Використовуйте замість нього
is_active	isActive
event_types	eventTypes
send_warnings	sendWarnings
warning_email	warningEmail
company_tins	companyTins
secret_token	secretToken
secret_token_header_name	secretTokenHeaderName
created_at	createdAt
updated_at	updatedAt

Ці ж застарілі параметри присутні у відповідях на створення та оновлення підписки. Далі в статті вони не повторюються.