Retrieve device messages

GET

https://api.applivery.io/v1/organizations/{organizationId}/mdm/device-messages

Request

Send your API key in the request header authorization

Example: Authorization: Bearer <token>

organizationId string

required

Match pattern: ^[a-fA-F0-9]{24}$

page integer

optional

Sequential page index for navigating large datasets, enabling systematic access to specific record subsets within the total collection.

limit integer

optional

Maximum number of records returned per request to control data density, optimize interface performance, and manage payload size.

sort string

optional

Ordering criteria using a field-to-direction mapping to organize results based on specific attributes like creation date, name, or status.

Match pattern: ^[\w.]*((:asc)|(:desc))?$

deviceId string

optional

Match pattern: ^[a-fA-F0-9]{24}$

deviceType string

optional

emmDeviceadmDevicewinDeviceaosDevice

origin string

optional

agentmdmautomationdashboard

code string

optional

ENROLLMENT_SUCCESSENROLLMENT_FAILEDENROLLMENT_UNENROLLEDCERTIFICATE_INSTALLEDCERTIFICATE_INSTALL_FAILEDCERTIFICATE_EXPIREDCERTIFICATE_EXPIRING_SOONCERTIFICATE_REVOKEDPOLICY_APPLIEDPOLICY_APPLY_FAILEDPOLICY_VIOLATIONPOLICY_REMOVEDCOMPLIANCE_CHECK_PASSEDCOMPLIANCE_CHECK_FAILEDCOMPLIANCE_CHECK_ERRORSECURITY_JAILBREAK_DETECTEDSECURITY_ENCRYPTION_DISABLEDSECURITY_PASSCODE_MISSINGAPP_INSTALLEDAPP_INSTALL_FAILEDAPP_UNINSTALLEDAPP_UPDATE_REQUIREDPROFILE_INSTALLEDPROFILE_INSTALL_FAILEDPROFILE_REMOVEDDEVICE_RESTARTEDDEVICE_WIPEDDEVICE_LOCKEDDEVICE_STORAGE_LOWOS_UPDATE_REQUIREDOS_UPDATE_AVAILABLEOS_UNSUPPORTEDOS_VERSION_BELOW_MINIMUMUNKNOWN

severity string

optional

infowarningerrorcritical

Responses

200 Response application/json

status boolean required

data object required

items array [object] required

id string required

Match pattern: ^[a-fA-F0-9]{24}$

organizationId string required

Match pattern: ^[a-fA-F0-9]{24}$

deviceInfo object required

fingerprint string required

≤ 500 characters

origin string required

agent mdm automation dashboard

event object required

occurrence object required

expiresAt string required

createdAt string required

updatedAt string required

version number required

totalDocs integer required

≥ -9007199254740991 · ≤ 9007199254740991

limit integer required

≥ -9007199254740991 · ≤ 9007199254740991

hasPrevPage boolean required

hasNextPage boolean required

page integer required

≥ -9007199254740991 · ≤ 9007199254740991

totalPages integer required

≥ -9007199254740991 · ≤ 9007199254740991

prevPage integer required

≥ -9007199254740991 · ≤ 9007199254740991

nextPage integer required

≥ -9007199254740991 · ≤ 9007199254740991

{
    "status": true,
    "data": {
        "items": [
            {
                "id": "string",
                "organizationId": "string",
                "deviceInfo": {
                    "id": "string",
                    "type": "emmDevice"
                },
                "fingerprint": "string",
                "origin": "agent",
                "event": {
                    "code": "ENROLLMENT_SUCCESS",
                    "severity": "info",
                    "content": "string"
                },
                "occurrence": {
                    "count": 0,
                    "firstOccurredAt": "string",
                    "lastOccurredAt": "string"
                },
                "expiresAt": "string",
                "createdAt": "string",
                "updatedAt": "string",
                "version": 0
            }
        ],
        "totalDocs": 0,
        "limit": 0,
        "hasPrevPage": true,
        "hasNextPage": true,
        "page": 0,
        "totalPages": 0,
        "prevPage": 0,
        "nextPage": 0
    }
}

400 Response application/json

status boolean optional

false

error object optional

code number optional

6002

message string optional

Body Validation Error

{
    "status": false,
    "error": {
        "code": 6002,
        "message": "Body Validation Error"
    }
}

401 Response application/json

status boolean optional

false

error object optional

code number optional

4004

message string optional

Invalid Token

{
    "status": false,
    "error": {
        "code": 4002,
        "message": "No auth token"
    }
}

Request

Authorization

Path Params1

Query Params8

Responses