FCM Token API

Last updated: May 22, 2026

The FCM Token API lets you retrieve the Firebase Cloud Messaging tokens registered for your app. Each token represents a specific device installation. You can use this API to build your own notification infrastructure, sync your user list with an external CRM, or audit which devices are registered.

Endpoint

GET https://appilix.com/api/push-notification-token

Required Parameters

ParameterDescription
app_keyYour app key, found in the Appilix dashboard
api_keyYour API key, found in the Firebase settings page

Optional Parameters

ParameterDefaultDescription
user_identity—Filter tokens for a specific user identity
page1Page number for pagination
items_per_page100Number of tokens returned per page
secondary_app_key—App key for a second app (e.g., iOS)
secondary_api_key—API key for the secondary app

Response Format

json
{
    "status": true,
    "current_page": 1,
    "has_next_page": false,
    "tokens": [
        {
            "token": "fcm-device-token-string",
            "user_identity": "user@example.com",
            "modified_at": "2026-05-22 10:30:00"
        }
    ]
}
FieldDescription
statustrue if the request succeeded, false if credentials are invalid
current_pageThe page number returned
has_next_pagetrue if more pages of results exist
tokensArray of token records
tokens[].tokenThe FCM device token
tokens[].user_identityThe identity recorded for this device, or empty if not set
tokens[].modified_atWhen the token was last updated

Pagination

Results are paginated. Use page and items_per_page to step through large lists:

?app_key=YOUR_APP_KEY&api_key=YOUR_API_KEY&page=2&items_per_page=50

Check has_next_page in the response to determine whether additional pages exist.

Filtering by User

To retrieve tokens for a specific user, pass their identity:

?app_key=YOUR_APP_KEY&api_key=YOUR_API_KEY&user_identity=user@example.com

Fetching Tokens for Two Apps

If you have separate Android and iOS apps, include secondary_app_key and secondary_api_key. The response will contain results for both apps indexed separately.

Error Response

json
{
    "status": false,
    "message": "Invalid Primary `api_key`."
}