Retrieve organization devices

Retrieve a list of all the devices associated with an organization.

Request
Security:
bearerAuth
path Parameters
orgId
required
string

The ID of the organization. Obtain this from GET /organizations.

Example: 62
query Parameters
groupId
string

Filter by the ID of the group. Obtain this from GET /organizations/{orgId}/devices. If a groupId of -1 is selected, the device will be added without being assigned to any group.

Example: groupId=62
name
string

Filter by the name of the user.

Example: name=Mike
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
located
string

Filter for located devices only.

limit
string^([1-9]|[0-9][0-9]|1[0-9][0-9]|200)$
Default: "0"

Set the maximum number of pagination results to receive.

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

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

Example: offset=1
Responses
200

Successful operation

400

Bad request error

401

Unauthorized error

403

Forbidden error

404

Not found error

500

Internal server error

get/organizations/{orgId}/devices
Request samples
curl -i -X GET \
  'https://api-prod.surfsight.net/v2/organizations/:orgId/devices?groupId=62&name=Mike&imei=12345678&located=string&limit=199&offset=1' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
Response samples
    1 more
    500
application/json
{
  • "data": [
    ],
  • "metadata": {
    }
}