Skip to main content

Get Devices

This request returns a list of devices used for push notifications.

get /push/devices

Sample

A sample GET request to get devices matching the criteria in the request URL:

curl -X GET \
'https://api.carrierx.com/core/v2/push/devices' \
-H 'Authorization: Bearer 5ebc03d6-8b2b-44ad-bf65-72d4f1491dda'

Response

200 status code with a list of Device objects:

{
"count": 1,
"has_more": false,
"items": [
{
"application_sid": "b3edc875-f73c-4c48-895a-8697b92b8d07",
"application_version": null,
"device_sid": "56d485ae-0693-421a-91eb-6b02b152573a",
"environment": "production",
"os_version": null,
"partner_sid": "e00430c3-a7d0-4666-ab5c-f7202448382f",
"token": "1111",
"type": "ios"
}
],
"limit": 10,
"offset": 0,
"pagination": {},
"total": 1
}

This request is enabled for Pagination, Result Filtering, and Field Filtering.

Required Scopes

To get information about Device objects, the partner must have one of the following scopes enabled:

  • push.manage
  • push.read

Query Arguments

ParameterData TypeDescription
with_relatedbooleanDetermines if the partner information related to the device should be shown. Values accepted in this field are true and false. The default value is false.