Subscription list

Retrieve all subscriptions

get

/tracking-push/subscribers

Retrieve a list of all subscriptions associated with the client.

Authorizations

AuthorizationstringRequired

Authorization JWT-token with a lifetime of 1 hour in header

Query parameters

pageintegerOptional

The page number to return.

Example: 1

limitintegerOptional

The maximum number of items to return per page.

Example: 10

Responses

200

Successful response containing a list of subscriptions.

application/json

current_pageintegerOptional

The current page of the paginated result set.

Example: 1

last_pageintegerOptional

The last page of the paginated result set.

Example: 1

per_pageintegerOptional

The number of items per page.

Example: 15

totalintegerOptional

The total number of subscription items available.

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": []
    }
  ]
}

Deprecated parameters

Some parameters are duplicated in snake_case notation. These parameters are kept solely for backward compatibility — use the camelCase variants for new integrations.

Deprecated parameter	Use instead
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

The same deprecated parameters are present in the responses to subscription creation and update. They are not repeated further in this article.