Skip to main content

Get all tokens

Gets all tokens available for a :user_id

URL: https://api.courier.com/users/:user_id/tokens

Method: GET

PATH PARAMS

user_idstringrequired
The user's ID. This can be any uniquely identifiable string.
RESPONSES:

status: 200 OK

tokensarray
A list of tokens registered with the user.
+ Show Properties

status: 400 Bad Request

messagestring
A message describing the error that occurred.
typestring
[invalid_request_error] The type of error that occurred.
Request Example
curl --request GET \
--url https://api.courier.com/users/user-1234/tokens \
--header 'Accept: application/json'
Responses Example
{
"tokens": [
{
"provider_key": "firebase-fcm",
"device": {
"app_id": "com.example.app",
"ad_id": "1234567890",
"device_id": "1234567890",
"platform": "android",
"manufacturer": "Samsung",
"model": "SM-G930F"
},
"tracking": {
"os_version": "9",
"ip": "1.2.3.4",
"lat": "1.2",
"long": "3.4"
},
"expiry_date": "2030-01-01T00:00:00.000Z",
"status": "active"
}
]
}
{
"message": "Error Message",
"type": "invalid_request_error"
}

Examples:‚Äč

Request:

  • URL: `/users/user-1234/tokens
  • Method: GET

Response:

{
"tokens": [
{
"token": "ads23fghsdfgsd32",
"provider_key": "apn",
"properties": {
"is_person": true
},
"device": {
"app_id": "com.my.app",
"platform": "iOS",
"model": "iPhone 13"
}
},
{
"token": "jkfs23dvsjdfh23G",
"provider_key": "apn",
"properties": {
"is_person": false
},
"device": {
"app_id": "com.my.app",
"platform": "iOS",
"model": "iPad Mini"
}
}
]
}
Was this helpful?