Plum / developers
REST APIDevices

Get a device

GET/devices/{id}

Authorization

bearerAuth
AuthorizationBearer <token>

Send Authorization: Bearer <token> with one of: an app session access token from /auth/verify-otp or /auth/refresh; an OAuth access token from /oauth/token issued for the API origin (its scopes are its permissions); or a personal access token starting with optima_pat_ (see /docs/personal-access-tokens). Personal access tokens cannot create or list tokens, revoke other tokens, sign out, or delete or restore the account. Content routes need the permission of their layer: audio:read/audio:write for recordings, turns:read/turns:write for turns, contacts, source signals, and events, and insights:read/insights:write for suggestions and session summaries; search and recall need turns:read and insights:read. A request without the permission, or for an account whose layer is turned off, returns 403 FORBIDDEN. See /docs/authentication#scopes.

In: header

Path Parameters

id*string
Length1 <= length <= 200

Header Parameters

X-API-Version?"1"

Send 1 to pin the documented API contract. If omitted, the latest version is selected.

Default"1"

Value in

  • "1"

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/devices/string" \  -H "X-API-Version: 1"
{  "success": true,  "data": {    "id": "string",    "created_at": "2019-08-24T14:15:22Z",    "bound_at": "2019-08-24T14:15:22Z",    "project_id": "string",    "firmware_version": "string",    "target_id": "string",    "hardware_id": "string",    "firmware_commit": "string",    "firmware_environment": "string",    "last_online_at": "2019-08-24T14:15:22Z",    "source": {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "kind": "string",      "name": "string",      "created_at": "2019-08-24T14:15:22Z"    },    "binding_kind": "string",    "session_id": "1ffd059c-17ea-40a8-8aef-70fd0307db82"  }}