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

REST API v4: GET profile web push subscriptions

This method retrieves all browser push subscriptions associated with a specific profile.

A browser push subscription represents a browser that has granted permission to receive push notifications.

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

https://api.copernica.com/v4/profile/$id/push/websubscriptions

Replace $id with the ID of the profile.

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": "2",
    "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);

// replace {$id} with the ID of the profile
$api->get("profile/{$id}/push/websubscriptions");

This example requires the REST API class.