Get User Device

GET 
/v1/:clientId/user-devices/:deviceId

This endpoint returns all details of a specific device.

This includes all tags and associated IDs.

Request

Path Parameters

clientId stringrequired
deviceId stringrequired

Header Parameters

X-API-KEY string
Example: bsKXkZhhdczuaHZ4xwVGk47Mbm77Epcf
X-REALM string
Example: incrowd
X-APP-ID string
Example: ios

Responses

200

OK

Response Headers

• Content-Type

  string

• Content-Length

  integer

• Connection

  string

• Date

  string

• Vary

  string

• X-Cache

  string

• Via

  string

• X-Amz-Cf-Pop

  string

• X-Amz-Cf-Id

  string

application/json

Schema

Schema

object

Example (from schema)

{}

Example

{
  "status": "success",
  "data": {
    "id": "600578c2fe16620d09d43327",
    "clientId": "INCROWD",
    "deviceId": "1234-5678",
    "authId": null,
    "associatedIds": [
      {
        "type": "onesignalId",
        "value": "1234-5678"
      }
    ],
    "sessionCount": null,
    "language": "EN",
    "location": {
      "type": "Point",
      "coordinates": [
        51.39812488982958,
        -0.08564990611849756
      ]
    },
    "duration": 1000,
    "lastSession": "2021-02-02T17:41:02.243Z",
    "country": null,
    "platform": "IOS",
    "appVersion": "4.2.1",
    "createdAt": "2021-01-18T12:02:10.368Z",
    "updatedAt": "2021-02-02T17:41:02.243Z",
    "tags": [
      {
        "name": "NoExpiry",
        "value": true,
        "expiry": null,
        "source": "USER"
      },
      {
        "name": "SomethingNew",
        "value": "2020-01-07T03:02:01Z",
        "expiry": "2020-01-18T03:02:01.000Z",
        "source": "USER"
      },
      {
        "name": "Something",
        "value": true,
        "expiry": "2021-01-14T03:02:01.000Z",
        "source": "USER"
      }
    ],
    "audiences": [
      {
        "name": "AUDIENCE_123",
        "value": true,
        "expiry": null,
        "source": "SYSTEM"
      }
    ]
  },
  "metadata": {
    "createdAt": "2021-02-02T17:41:22.478Z"
  }
}

Loading...