Sign in

v1

latestOpenAPI 3.0.3RingCentral API License Agreement2026-08-064871,2921.5 MB
Devices

Get Device

Returns account device(s) by their ID(s).

get/restapi/v1.0/account/{accountId}/device/{deviceId}

Path parameters

accountIdstring required

Internal identifier of the RingCentral account (can be set to "~" to indicate that the account associated with current authorization session should be used)

deviceIdstring required

Internal identifier of a device

Query parameters

syncEmergencyAddressboolean

Specifies if an emergency address should be synchronized or not

Response

Account device(s) information

idstring

Internal identifier of a device

uristring uri

Canonical URI of a device

skustring

Device identification number (SKU, Stock Keeping Unit) in the format TP-ID [-AT-AC], where TP is device type (HP for RC desk phones, DV for all other devices including soft phones); ID - device model ID; AT - add-on type ID; AC - add-on count (if any). For example 'HP-56-2-2'

type'BLA' | 'SoftPhone' | 'OtherPhone' | 'HardPhone' | 'WebPhone' | 'Paging' | 'Room' | 'WebRTC'

Device type

namestring

Device name. Mandatory if ordering SoftPhone or OtherPhone. Optional for HardPhone. If not specified for HardPhone, then a device model is used as a device name

serialstring

Serial number for HardPhone (is returned only when the phone is shipped and provisioned); endpoint ID for SoftPhone and mobile applications

status'Offline' | 'Online'

Device status

computerNamestring

Computer name (for devices of SoftPhone type only)

boxBillingIdinteger

Box billing identifier of a device. Applicable only for devices of HardPhone type. It is an alternative way to identify the device to be ordered. Either model structure, or boxBillingId must be specified

useAsCommonPhoneboolean

Supported only for devices assigned to Limited extensions. If true, enables users to log in to this phone as a common phone.

hotDeskDeviceboolean

This flag indicates whether this device is used for hot desking or not

inCompanyNetboolean

Network location status. true if the device is located in the configured corporate network (On-Net); false for Off-Net location. Parameter is not returned if EmergencyAddressAutoUpdate feature is not enabled for the account/user, or if device network location is not determined

lastLocationReportTimestring date-time

Date/time of receiving last location report in ISO 8601 format including timezone, for example *2016-03-10T18:07:52.534Z

linePooling'Host' | 'Guest' | 'None'

Pooling type of device:

  • Host - device with a standalone paid phone line which can be linked to soft phone client instance;
  • Guest - device with a linked phone line;
  • None - device without a phone line or with a specific line (free, BLA, etc.)

Example response

{
  "shipping": {
    "status": "Shipped"
  }
}