List Device Registrations

import { TwilioClient } from "twilio-comms";
async function main() {
    const client = new TwilioClient({
        accountId: "YOUR_ACCOUNTID_HERE",
        authToken: "YOUR_AUTHTOKEN_HERE",
    });
    await client.pushNotifications.deviceRegistrations.list({
        userId: "comms_pushnotificationuser_01h9krwprkeee8fzqspvwy6nq8",
    });
}
main();

{
  "deviceRegistrations": [
    {
      "id": "comms_device_registration_qspvwy6nq801h9krwprkeee8fz",
      "appName": "limonade_app",
      "userId": "comms_pushnotificationuser_01h9krwprkeee8fzqspvwy6nq8",
      "devices": [
        {
          "token": "dqWD7WEC83K41WHyufTS7:APA91bFcrVaOLqKeJfSiEutJXX2Tr9wN_tYOwYd8rFA6mYUMBFqdz9n6k3v5EpFA_ukXD89hGqG3OarzbVfdjGnLOIAQfwbQcqJkjQWMrhwElrtU1y3JLDPfnjc0eTJLxzhyYvDFopEh",
          "provider": "FCM"
        },
        {
          "token": "00fc13adff785122b4ad28809a3420982341241421348097878e577c991de8f0",
          "provider": "APN"
        }
      ],
      "related": [
        {
          "name": "PUSH_NOTIFICATION_APP",
          "id": "limonade_app",
          "uri": "https://comms.twilio.com/v1/PushNotifications/Apps/limonade_app"
        },
        {
          "name": "PUSH_NOTIFICATION_USER",
          "id": "comms_pushnotificationuser_01h9krwprkeee8fzqspvwy6nq8",
          "uri": "https://comms.twilio.com/v1/PushNotifications/Users/comms_pushnotificationuser_01h9krwprkeee8fzqspvwy6nq8"
        }
      ]
    }
  ],
  "pagination": {
    "next": "string",
    "self": "eyJTSyI6IkEjMDFqbmVoYm5xYWZmNDlrazUxZHA1bmN5bXciLCJTSzEiOiJBI2FjdGl2YXRlZCMyMDI1LTAzLTAzVDE3OjM3OjQ3WiMwMWpuZWhibnFhZmY0OWtrNTFkcDVuY3ltdyIsIlBLIjoiQyNBQzYwMzg4ODJiZDY5ZWIyNGM4YzU4ZGI5NjE4NjE3OTE4I0EifQ=="
  }
}

This operation fetches a paginated list of Device Registrations with the ID of the User they belong to and the name of the App that they are for.

A Device Registration contains a list of devices registered for a particular User under an App
The Device tokens in the Device Registration are used for delivering Push Notifications to the given App on devices or browsers belonging to a single User.
Each User will have one Device Registration for each App.
When sending Push Notifications to a User, all of the devices registered under the Device Registration with the corresponding appName are targets for the Push Notification.

This operation fetches a paginated list of Device Registrations with the ID of the `User` they belong to and the name of the `App` that they are for. * A Device Registration contains a list of devices registered for a particular `User` under an `App` * The `Device` tokens in the Device Registration are used for delivering Push Notifications to the given `App` on devices or browsers belonging to a single User. * Each User will have one Device Registration for each `App`. * When sending Push Notifications to a User, all of the devices registered under the Device Registration with the corresponding `appName` are targets for the Push Notification.

Authentication

AuthorizationBasic

Basic authentication of the form Basic <account_id:auth_token>.

AuthorizationBasic

Basic authentication of the form Basic <api_key:api_key_secret>.

Query parameters

userIdstringRequiredformat: "^comms_pushnotificationuser_[0-7][a-hjkmnpqrstv-z0-9]{25,34}"

Filter Device Registrations by User.id to retrieve only registrations for that User.

appNamestringOptionalformat: "^[a-z0-9_]+$"1-64 characters

Filter Device Registrations by their appName. Must be accompanied by the userId query parameter.

pageTokenstringOptional

The token to retrieve the next page of results.

pageSizeintegerOptional1-1000Defaults to 50

The number of resources to return in a page.

Response

deviceRegistrationslist of objects

List of Device Registrations.

paginationobject

Metadata for paginated results. This object contains two tokens to navigate through paginated results.

Use next to retrieve the ‘next’ page in the result list.
Use self to retrieve the same page of the result list again.
Supply the token in the pageToken query param.

Metadata for paginated results. This object contains two tokens to navigate through paginated results. - Use `next` to retrieve the 'next' page in the result list. - Use `self` to retrieve the same page of the result list again. - Supply the token in the `pageToken` query param.

Errors

400

Bad Request Error

429

Too Many Requests Error

500

Internal Server Error

503

Service Unavailable Error