Apis::V4::PushNotification::DeviceToken API

list user's push notification device tokens

Parameters

Name	Description
access_token	JSON Web Token retrieved from the Sessions endpoint (you can also pass this into the Authorization header)
page	pagination details: - page[limit] = number of records you want to receive per page, default 25 - page[offset] = skip the first n number of records, default 0
sort	order you want to receive records in, defaults to id.
include	comma delimited relationships you want included in the response in snake_case format

Response Fields

Name	Description
data	primary JSON API payload
included	related models (controlled by the include param)
meta	will contain additional information about the current request, including the total number of records before the limit/offset operations

Request

Headers

Version: HTTP/1.0
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjo4MSwiZXhwIjoxNzU0NTk2NDc5LCJpYXQiOjE3NTQ1OTYyOTl9.co-PK01FCPrALkgyF5BbPgcaYvh65GJ8xyHSQ1a2bKU
Host: example.org
Cookie:

Route

GET /apis/v4/push_notification_device_tokens?include=*

Query Parameters

include=*

Response

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Content-Type: application/vnd.api+json
Vary: Accept
X-MH-Session: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjo4MSwiZXhwIjoxNzU0NzY5MDk5LCJpYXQiOjE3NTQ1OTYyOTl9.bNsQGpEQiFwmaLK1UdNexK65ICJVgcTbkxqWdeSsEFo
Access-Control-Expose-Headers: X-MH-Session
ETag: W/"a9d81ca027d8dbf339bef8debd39c6f9"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 7d8dbfab-a707-44b5-ae8c-2da5e2c70838
X-Runtime: 0.015565
Content-Length: 727

Status

Body

{
  "data": [
    {
      "id": "8",
      "type": "push_notification_device_token",
      "attributes": {
        "token": "0f9d87489bca2a12298bbed8ab54d052",
        "platform": "APNS_SANDBOX",
        "updated_at": "2025-08-07T19:51:39Z",
        "created_at": "2025-08-07T19:51:39Z"
      },
      "relationships": {
        "user": {
          "data": {
            "id": "81",
            "type": "user"
          }
        }
      }
    }
  ],
  "included": [
    {
      "id": "81",
      "type": "user",
      "attributes": {
        "timezone": null,
        "hidden_organizations": null,
        "organization_order": null,
        "terms_acceptance_date": null,
        "language": null,
        "mobile_language": null,
        "notification_settings": null,
        "pathway_stage_id": "",
        "onboarding_status": null,
        "username": "email_address_email_80@email.com",
        "created_at": "2025-08-07T19:51:39Z",
        "updated_at": "2025-08-07T19:51:39Z",
        "last_sign_in_at": null,
        "groups_feature": true
      }
    }
  ],
  "meta": {
    "total": 1
  }
}