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

REST API v4: GET push mobile subscriptions

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

A mobile push subscription represents a registered device that can receive mobile push notifications. A subscription is linked to a profile or subprofile and references a Google Firebase project.

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

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

Returned fields

This method returns a collection of mobile push subscriptions.

Name Description
ID Unique identifier of the mobile push subscription.
created Date and time when the subscription was created.
updated Date and time when the subscription was last updated.
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.
project ID of the associated Google Firebase project.
model Device model, if known.
os Device operating system, for example ios or android.

JSON example

The JSON response looks like the following:

{
    "ID": "1",
    "created": "2026-06-15 12:18:26",
    "updated": "2026-06-15 12:18:26",
    "expired": "",
    "profile": "1234",
    "subprofile": "",
    "project": 1,
    "model": "iPhone1",
    "os": "ios"
}

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/mobilesubscriptions");

This example requires the REST API class.