Devices
Returns devices for specified tenant This endpoint returns paged results of up to 10,000 records per response, using the X-CONTINUATIONTOKEN header. When the response includes this token, it indicates that additional records are available. To retrieve the next set of results, include the X-CONTINUATIONTOKEN token from the previous response header in the header of your subsequent request. This process can be repeated until no further continuation token is provided, indicating that you have reached the end of the dataset.
Tenant Var Code
When 'subtenants=true' the list contains devices for the tenant and all subtenants
falseIf true, result include Base64 encoded device photo
falseOK
Tenant Var Code
A string that uniquely identifies the device. It can contain only letters, digits, hyphen and can be up to 50 characters long. This is normally the IMEI number
A string enumeration that defines the device type. For list of avalibale device types check your tenant object
A string used to more easily identify the device
A text string used to describe the device
The username (email address) of the assigned owner of the device
The userId of the assigned owner of the device
The current status of the device. Valid values are: "Active" or "Inactive"
The date (UTC) that the device was registered on the platform
Reference to Group or null when device is not member of any group
A boolean indicating if the schedule is checked or not
If set "true", the device can be emailed from any email client using the following address format "imei@globalalerting.com"
If set "true", the sms messages from the device will include a reply link
A boolean indicating if the device is currently monitored
A whole number that specifies number of minutes for device monitoring interval
A whole number that specifies number of minutes buffer for device monitoring
A flag indicating that the emergency state on the device has been acknowledged on the portal
A string starting with '+' indicating device phone number (can be used only if device supports phone number property)
Last known position of the device
Last known position of the device
A date and time of last MO Message (UTC)
A date and time of last MO Message with position (UTC)
Timestamp (UTC) indicating version of record being returned
ETag representing record version
Base64 encoded device photo. Included in GET request only when photo parameter is specified.
Custom Email address. If supported for your account
Secondary Device Id for devices that send messages with multiple device identifiers.
GET /V2/{tenantVarCode}/devices HTTP/1.1
Accept: */*
OK
[
{
"TenantCode": "text",
"DeviceId": "text",
"DeviceType": "text",
"FriendlyName": "text",
"Description": "text",
"Username": "text",
"UserId": "text",
"DeviceStatus": "text",
"ProvisioningStatus": "Provisioned",
"DateAdded": "2026-01-01T00:00:00.000Z",
"GroupId": "text",
"CheckInScheduleEnabled": true,
"CheckInScheduleOverdue": "NotOverdue",
"EnableEmailDelivery": true,
"EnableSmsReplies": true,
"IsMonitored": true,
"MonitoringIntervalMinutes": 1,
"MonitoringBufferMinutes": 1,
"MonitoringOverdue": "NotOverdue",
"EmergencyState": "None",
"EmergencyStateAcknowledged": true,
"PhoneNumber": "text",
"LastLatitude": 1,
"LastLongitude": 1,
"LastMessageTime": "2026-01-01T00:00:00.000Z",
"LastLocationTime": "2026-01-01T00:00:00.000Z",
"Properties": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"Timestamp": "2026-01-01T00:00:00.000Z",
"ETag": "text",
"Photo": "text",
"CustomEmailAddress": "text",
"SecondaryDeviceId": "text"
}
]Creates a new device Set GapAppSendEmail property to true when you are creating a new GapApp device and you want assigned user to receive welcome email.
Tenant Var Code
Tenant Var Code
A string that uniquely identifies the device. It can contain only letters, digits, hyphen and can be up to 50 characters long. This is normally the IMEI number
A string enumeration that defines the device type. For list of avalibale device types check your tenant object
A string used to more easily identify the device
A text string used to describe the device
The username (email address) of the assigned owner of the device
The userId of the assigned owner of the device
The current status of the device. Valid values are: "Active" or "Inactive"
The date (UTC) that the device was registered on the platform
Reference to Group or null when device is not member of any group
A boolean indicating if the schedule is checked or not
If set "true", the device can be emailed from any email client using the following address format "imei@globalalerting.com"
If set "true", the sms messages from the device will include a reply link
A boolean indicating if the device is currently monitored
A whole number that specifies number of minutes for device monitoring interval
A whole number that specifies number of minutes buffer for device monitoring
A flag indicating that the emergency state on the device has been acknowledged on the portal
A string starting with '+' indicating device phone number (can be used only if device supports phone number property)
Last known position of the device
Last known position of the device
A date and time of last MO Message (UTC)
A date and time of last MO Message with position (UTC)
Timestamp (UTC) indicating version of record being returned
ETag representing record version
Base64 encoded device photo. Included in GET request only when photo parameter is specified.
Custom Email address. If supported for your account
Secondary Device Id for devices that send messages with multiple device identifiers.
OK
No content
POST /V2/{tenantVarCode}/devices HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 854
{
"TenantCode": "text",
"DeviceId": "text",
"DeviceType": "text",
"FriendlyName": "text",
"Description": "text",
"Username": "text",
"UserId": "text",
"DeviceStatus": "text",
"ProvisioningStatus": "Provisioned",
"DateAdded": "2026-01-01T00:00:00.000Z",
"GroupId": "text",
"CheckInScheduleEnabled": true,
"CheckInScheduleOverdue": "NotOverdue",
"EnableEmailDelivery": true,
"EnableSmsReplies": true,
"IsMonitored": true,
"MonitoringIntervalMinutes": 1,
"MonitoringBufferMinutes": 1,
"MonitoringOverdue": "NotOverdue",
"EmergencyState": "None",
"EmergencyStateAcknowledged": true,
"PhoneNumber": "text",
"LastLatitude": 1,
"LastLongitude": 1,
"LastMessageTime": "2026-01-01T00:00:00.000Z",
"LastLocationTime": "2026-01-01T00:00:00.000Z",
"Properties": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"Timestamp": "2026-01-01T00:00:00.000Z",
"ETag": "text",
"Photo": "text",
"CustomEmailAddress": "text",
"SecondaryDeviceId": "text"
}OK
No content
Tenant Var Code
Device Id
If true, result include Base64 encoded device photo
falseOK
Tenant Var Code
A string that uniquely identifies the device. It can contain only letters, digits, hyphen and can be up to 50 characters long. This is normally the IMEI number
A string enumeration that defines the device type. For list of avalibale device types check your tenant object
A string used to more easily identify the device
A text string used to describe the device
The username (email address) of the assigned owner of the device
The userId of the assigned owner of the device
The current status of the device. Valid values are: "Active" or "Inactive"
The date (UTC) that the device was registered on the platform
Reference to Group or null when device is not member of any group
A boolean indicating if the schedule is checked or not
If set "true", the device can be emailed from any email client using the following address format "imei@globalalerting.com"
If set "true", the sms messages from the device will include a reply link
A boolean indicating if the device is currently monitored
A whole number that specifies number of minutes for device monitoring interval
A whole number that specifies number of minutes buffer for device monitoring
A flag indicating that the emergency state on the device has been acknowledged on the portal
A string starting with '+' indicating device phone number (can be used only if device supports phone number property)
Last known position of the device
Last known position of the device
A date and time of last MO Message (UTC)
A date and time of last MO Message with position (UTC)
Timestamp (UTC) indicating version of record being returned
ETag representing record version
Base64 encoded device photo. Included in GET request only when photo parameter is specified.
Custom Email address. If supported for your account
Secondary Device Id for devices that send messages with multiple device identifiers.
GET /V2/{tenantVarCode}/devices/{deviceId} HTTP/1.1
Accept: */*
OK
{
"TenantCode": "text",
"DeviceId": "text",
"DeviceType": "text",
"FriendlyName": "text",
"Description": "text",
"Username": "text",
"UserId": "text",
"DeviceStatus": "text",
"ProvisioningStatus": "Provisioned",
"DateAdded": "2026-01-01T00:00:00.000Z",
"GroupId": "text",
"CheckInScheduleEnabled": true,
"CheckInScheduleOverdue": "NotOverdue",
"EnableEmailDelivery": true,
"EnableSmsReplies": true,
"IsMonitored": true,
"MonitoringIntervalMinutes": 1,
"MonitoringBufferMinutes": 1,
"MonitoringOverdue": "NotOverdue",
"EmergencyState": "None",
"EmergencyStateAcknowledged": true,
"PhoneNumber": "text",
"LastLatitude": 1,
"LastLongitude": 1,
"LastMessageTime": "2026-01-01T00:00:00.000Z",
"LastLocationTime": "2026-01-01T00:00:00.000Z",
"Properties": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"Timestamp": "2026-01-01T00:00:00.000Z",
"ETag": "text",
"Photo": "text",
"CustomEmailAddress": "text",
"SecondaryDeviceId": "text"
}Tenant Var Code
Device Id
Tenant Var Code
A string that uniquely identifies the device. It can contain only letters, digits, hyphen and can be up to 50 characters long. This is normally the IMEI number
A string enumeration that defines the device type. For list of avalibale device types check your tenant object
A string used to more easily identify the device
A text string used to describe the device
The username (email address) of the assigned owner of the device
The userId of the assigned owner of the device
The current status of the device. Valid values are: "Active" or "Inactive"
The date (UTC) that the device was registered on the platform
Reference to Group or null when device is not member of any group
A boolean indicating if the schedule is checked or not
If set "true", the device can be emailed from any email client using the following address format "imei@globalalerting.com"
If set "true", the sms messages from the device will include a reply link
A boolean indicating if the device is currently monitored
A whole number that specifies number of minutes for device monitoring interval
A whole number that specifies number of minutes buffer for device monitoring
A flag indicating that the emergency state on the device has been acknowledged on the portal
A string starting with '+' indicating device phone number (can be used only if device supports phone number property)
Last known position of the device
Last known position of the device
A date and time of last MO Message (UTC)
A date and time of last MO Message with position (UTC)
Timestamp (UTC) indicating version of record being returned
ETag representing record version
Base64 encoded device photo. Included in GET request only when photo parameter is specified.
Custom Email address. If supported for your account
Secondary Device Id for devices that send messages with multiple device identifiers.
OK
No content
PUT /V2/{tenantVarCode}/devices/{deviceId} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 854
{
"TenantCode": "text",
"DeviceId": "text",
"DeviceType": "text",
"FriendlyName": "text",
"Description": "text",
"Username": "text",
"UserId": "text",
"DeviceStatus": "text",
"ProvisioningStatus": "Provisioned",
"DateAdded": "2026-01-01T00:00:00.000Z",
"GroupId": "text",
"CheckInScheduleEnabled": true,
"CheckInScheduleOverdue": "NotOverdue",
"EnableEmailDelivery": true,
"EnableSmsReplies": true,
"IsMonitored": true,
"MonitoringIntervalMinutes": 1,
"MonitoringBufferMinutes": 1,
"MonitoringOverdue": "NotOverdue",
"EmergencyState": "None",
"EmergencyStateAcknowledged": true,
"PhoneNumber": "text",
"LastLatitude": 1,
"LastLongitude": 1,
"LastMessageTime": "2026-01-01T00:00:00.000Z",
"LastLocationTime": "2026-01-01T00:00:00.000Z",
"Properties": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"Timestamp": "2026-01-01T00:00:00.000Z",
"ETag": "text",
"Photo": "text",
"CustomEmailAddress": "text",
"SecondaryDeviceId": "text"
}OK
No content
Tenant Var Code
Device Id
OK
No content
PATCH /V2/{tenantVarCode}/devices/{deviceId} HTTP/1.1
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 56
[
{
"value": null,
"path": "text",
"op": "text",
"from": "text"
}
]OK
No content
Last updated