Home > Documentation > REST API v4: GET push web subscriptions

REST API v4: GET push web subscriptions

This method retrieves all browser push subscriptions available within the account.

A browser push subscription represents a browser that has granted permission to receive push notifications. A subscription is linked to a profile or subprofile and references a website tracker.

To retrieve the browser push subscriptions, send an HTTP GET request to the following URL:

https://api.copernica.com/v4/push/websubscriptions

Returned fields

This method returns a collection of browser push subscriptions.

Name Description
ID Unique identifier of the browser push subscription.
created Date and time when the subscription was created.
expired Date and time when the subscription expired. Empty if the subscription is still active.
profile ID of the associated profile.
subprofile ID of the associated subprofile.
webtracker ID of the associated website tracker.
endpoint Push endpoint used by the browser to deliver push notifications.

JSON example

The JSON response looks like the following:

{
    "ID": "1",
    "created": "2025-09-23 12:18:59",
    "expired": "2026-06-16 11:55:52",
    "profile": "1234",
    "subprofile": "",
    "webtracker": "1",
    "endpoint": "https://jmt17.google.com/fcm/send/{uniquehash}"
}

PHP example

The following script demonstrates how to use this API method.

// required scripts
require_once("CopernicaRestAPI.php");

// change this to your access token
$api = new CopernicaRestAPI("your-access-token", 4);

// execute the request
$api->get("push/websubscriptions");

This example requires the REST API class.