Get single token

Get single token available for a :token

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

Method: GET

Path Parameters

user_idstringrequired

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

tokenstringrequired

The value of the token you are trying to get

Responses

status: 200 OK

tokenstring

The full token string.

provider_keystringrequired

[apn | firebase-fcm | expo | onesignal] The provider token is to be associated with.

propertiesjson

Properties sent to the provider along with the token

deviceobject

Information about the device the token is associated with.

+ Show Properties

trackingobject

Information about the device the token is associated with.

+ Show Properties

expiry_datestring

ISO 8601 formatted date the token expires. Defaults to 2 months. Set to false to disable expiration.

statusstring

[active | unknown | failed | revoked] The status of the token.

status_reasonstring

The reason for the token status.

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

curl --request GET \
     --url https://api.courier.com/users/user-1234/tokens/ABW7HO9Y7XAQXZ7Y \
     --header 'Accept: application/json' 

Node.js

// Dependencies to install:
// $ npm install node-fetch --save

const fetch = require('node-fetch');

const options = {
  method: 'GET',
  headers: {
    Accept: 'application/json'
  },
};

fetch('https://api.courier.com/users/user-1234/tokens/ABW7HO9Y7XAQXZ7Y', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

Ruby

require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://api.courier.com/users/user-1234/tokens/ABW7HO9Y7XAQXZ7Y")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Accept"] = 'application/json'

response = http.request(request)
puts response.read_body

Python

# Dependencies to install:
# $ python -m pip install requests

import requests

url = "https://api.courier.com/users/user-1234/tokens/ABW7HO9Y7XAQXZ7Y"

headers = {
  "Accept": "application/json"
}

response = requests.request("GET", url, headers=headers)

print(response.text)

Go

package main

import (
  "fmt"
  "net/http"
  "io/ioutil"
)

func main() {

  url := "https://api.courier.com/users/user-1234/tokens/ABW7HO9Y7XAQXZ7Y"

  req, _ := http.NewRequest("GET", url, payload)

  req.Header.Add("Accept", "application/json")

  res, _ := http.DefaultClient.Do(req)

  defer res.Body.Close()
  body, _ := ioutil.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))

}

PHP

<?php
// Dependencies to install:
// $ composer require guzzlehttp/guzzle

require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.courier.com/users/user-1234/tokens/ABW7HO9Y7XAQXZ7Y', [
  'headers' => [
    'Accept' => 'application/json',
  ],
]);

echo $response->getBody();

Responses Example

{
  "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/ads23fghsdfgsd32
• Method: GET

Response:

{
  "token": "ads23fghsdfgsd32",
  "provider_key": "apn",
  "properties": {
    "is_person": true
  },
  "device": {
    "app_id": "com.my.app",
    "platform": "iOS",
    "model": "iPhone 13"
  }
}