Retrieve a list of RMA devices

Retrieve a list of RMA devices.

Request
Security:
bearerAuth
query Parameters
deviceName
string

Filter by the name of the RMA device.

Example: deviceName=0123456789ABCDEF
imei
string

Filter by the IMEI number of the device. The IMEI number can be found on a sticker on the device or on the back of the device box.

Example: imei=12345678
limit
string^[1-9]\d*$
Default: "0"

Set the maximum number of pagination results to receive.

Example: limit=1
offset
string^[1-9]\d*$
Default: "0"

Set the number of results to skip over before receiving pagination results.

Example: offset=1
order
string (Order)
Default: "desc"

Set the order that pagination results appear in - ascending or descending order.

Enum: "asc" "desc"
organizationName
string

Filter by the name of the organization.

Example: organizationName=Company Name
rmaUpdatedAtStart
string <date-time> (RMA Device updated time)

Filter by the date when the device is updated as RMA in ISO 8601 format.

rmaUpdatedAtEnd
string <date-time> (RMA Device updated time)

Filter by the end date when the device is updated as RMA in ISO 8601 format.

sort
string (Sort RMA device report)

Sort RMA device report by specific parameters, such as device names or IMEI numbers.

Enum: "organizationName" "imei" "rmaUpdatedAt" "deviceName"
Responses
200

Successful operation

400

Bad request error

401

Unauthorized error

403

Forbidden error

404

Not found error

500

Internal server error

get/devices/rma-devices
Request samples
curl -i -X GET \
  'https://api-prod.surfsight.net/v2/devices/rma-devices?deviceName=0123456789ABCDEF&imei=12345678&limit=1&offset=1&order=asc&organizationName=Company%20Name&rmaUpdatedAtStart=2019-08-24T14%3A15%3A22Z&rmaUpdatedAtEnd=2019-08-24T14%3A15%3A22Z&sort=organizationName' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
Response samples
    1 more
    500
application/json
{
  • "data": [
    ],
  • "metadata": {
    }
}