Skip to main content
GET
/
api
/
public
/
v1
/
devices
List devices
curl --request GET \
  --url https://app.msportal.ai/api/public/v1/devices \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "companyId": "<string>",
      "companyName": "<string>",
      "deviceTypeId": "<string>",
      "deviceTypeName": "<string>",
      "locationId": "<string>",
      "locationName": "<string>",
      "manufacturer": "<string>",
      "model": "<string>",
      "serialNumber": "<string>",
      "macAddress": "<string>",
      "ipAddress": "<string>",
      "os": "<string>",
      "firmwareVersion": "<string>",
      "status": "<string>",
      "lastSeen": "2023-11-07T05:31:56Z",
      "warrantyStart": "2023-11-07T05:31:56Z",
      "warrantyEnd": "2023-11-07T05:31:56Z",
      "warrantyExpires": "2023-11-07T05:31:56Z",
      "integrationSource": "<string>",
      "externalDeviceId": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "page": 2,
    "limit": 50,
    "totalCount": 123,
    "totalPages": 123,
    "hasNextPage": true,
    "hasPrevPage": true
  }
}

Authorizations

​
Authorization
string
header
required

Use your API key as a Bearer token. API keys can be generated in Settings → Integrations → API Access.

Query Parameters

​
page
number
default:1

Page number

Required range: x >= 1
​
limit
number
default:25

Items per page

Required range: 1 <= x <= 100
​
sortBy
enum<string>
default:created_at

Field to sort by

Available options:
name,
created_at,
updated_at,
last_seen,
status
​
sortDesc
boolean | null
default:true

Sort descending

​
search
string

Search by name, serial number, MAC, or IP

Maximum string length: 255
​
companyId
string<uuid>

Filter by company ID

​
deviceTypeId
string<uuid>

Filter by device type ID

​
locationId
string<uuid>

Filter by location ID

​
status
string

Filter by status

Maximum string length: 100
​
manufacturer
string

Filter by manufacturer

Maximum string length: 100
​
integrationSource
string

Filter by integration source

Maximum string length: 100

Response

List of devices

​
data
object[]
required

Array of devices

​
pagination
object
required