Skip to main content
GET
/
api
/
v1
/
entities
Error
A valid request URL is required to generate request examples
{
  "entities": {
    "period": [
      "'2021/01/25 10:00', '2021/02/01 11:30'"
    ],
    "dateFormat": "DD/MM/YYYY",
    "projects": [
      {
        "id": 123,
        "name": "<string>"
      }
    ],
    "sites": [
      {
        "id": 123,
        "name": "<string>"
      }
    ],
    "entitiesList": [
      {
        "id": 123,
        "type": "<string>",
        "label": "<string>",
        "totalIncursionsCount": 123,
        "authorisedIncursionsCount": 123,
        "unauthorisedIncursionsCount": 123,
        "lastActivity": "2021-12-15T12:06:49.399Z",
        "lastLocationCoordinates": {
          "lat": "50.09684",
          "lng": "19.880789"
        },
        "lastTestedFormatted": "about 2 hours ago",
        "slug": "<string>",
        "editPath": "<string>",
        "showPath": "<string>"
      }
    ],
    "pagination": {
      "currentPage": 123,
      "totalPages": 123,
      "currentPerPage": 123,
      "firstPage": 123,
      "lastPage": 123,
      "totalCount": 123
    }
  }
}

Headers

SensorzoneCurrentBrandOverride
number

Brand ID override for full admins

Query Parameters

projectsIds
number[]
sitesIds
number[]
dataFrom
string
dataTo
string
page
string

Provide page number for pagination

per
string

Define item count per page for pagination

sort
enum<string>

Sort data if param exist, otherwise return original, unsorted data

Available options:
asc,
desc
sortBy
enum<string>

Sort data by given param (if exist), otherwise return original, unsorted data

Available options:
serial_number,
name,
totalIncursionsCount,
acknowledgedIncursionsCount,
unacknowledgedIncursionsCount,
lastActivity
include_inactive
enum<string>

Include inactive entities in data (if param exist)

Available options:
0,
1
include_archived
enum<string>

Include archived entities in data (if param exist)

Available options:
0,
1
machine_kinds
string[]

Response

200 - application/json

people & machines list

entities
object