Getting started

{
  "items": [
    {
      "id": "dd40830b-b103-4f9a-ae02-bbf0d792466d", //ID of the mobile device
      "tenant": {
        "id": "b8a75c7d-7492-4009-9f95-8c815551dc55" //Tenant of the mobile device
      },
      "name": "AAA Chrome Work", //Name of the mobile device
      "email": "user@example.com", //Associated email of the mobile device
      "healthState": {
        "state": "amber", //Health statuts of the mobile device
        "mode": "automatic" //Whether the health status is set by Sophos Mobile based on the device's compliance or manually set by the admin.
      },
      "ownershipType": "corporate", //The device owner. "corporate" for devices owned by your organization, "personal" for devices owned by the user.
      "lastSeenAt": "2024-10-24T05:35:30.000Z", //The last timestamp when the device connected to Sophos Mobile
      "ixmAppLastSeenAt": "2024-10-24T05:35:30.000Z", //The last timestamp when the IXM app connected to Sophos Mobile
      "compliance": {
        "compliant": false, //The device isn't compliant
        "severity": "high" //The severity of the compliance violation. Here, "High".
      },
      "managementType": "chromeSecurity", //The device's management mode. Here, Sophos Chrome Security.
      "managedState": "managed", //The device's management status. Here, "Managed".
      "os": {
        "id": "4e880043-3206-4166-ab0b-3d9bf2a60196", //The ID of the device's operating system.
        "name": "Chrome 129", //The name of the device's operating system.
        "platform": "chrome" //The device platform.
      }
    }
  ],
  "pages": {
    "current": 1, //The current page
    "size": 50, //The number of items on a page. You can change this value with the pageSize=<int_value> query parameter.
    "total": 1, //The total number of pages
    "items": 1, //The total number of items on all pages
    "maxSize": 500 //The maximum allowed page size for the pageSize query parameter.
  }
}

{
    "id": "dd40830b-b103-4f9a-ae02-bbf0d792466d", //ID of the mobile device
    "tenant": {
        "id": "b8a75c7d-7492-4009-9f95-8c815551dc55" //Tenant of the mobile device
    },
    "name": "Chromebook 2687", //Name of the mobile device
    "description": "", //A description for the mobile device
    "phoneNumber": "", //The device's phone number configured in Sophos Mobile, if available
    "email": "user@example.com", //Email of the user assigned to the device
    "assignedPerson": {
        "id": "9f059011-84c7-4849-ae2e-d0563743e485", //ID of the assigned user
        "name": "Simon Smith", //Name of the assigned user
        "email": "user@example.com" //Email of the assigned user
    },
    "healthState": {
        "state": "amber", //Health statuts of the mobile device
        "mode": "automatic" //Health statuts mode of the mobile device
    },
    "ownershipType": "corporate", //Ownership Type indicates it's a company issued device
    "createdAt": "2024-10-15T14:18:50.000Z", //Timestamp the mobile device was created in the system
    "updatedAt": "2024-10-15T14:57:15.000Z", //Timestamp the mobile device was updated
    "lastSeenAt": "2024-10-24T05:35:30.000Z", //Timestamp the device connected to the server
    "ixmAppLastSeenAt": "2024-10-24T05:35:30.000Z", //Timestamp the IXM app connected to the server
    "compliance": {
        "compliant": false, //Mobile device isn't compliant
        "severity": "high" //The severity of the compliance violation is high
    },
    "modelName": "Google Chromebook", //The model name of the mobile device
    "managementType": "chromeSecurity", //The mobile device is only managed by the Chrome Security Extension
    "managedState": "managed", //The management state of the mobile device
    "os": {
        "id": "4e880043-3206-4166-ab0b-3d9bf2a60196", //The ID of this OS entry
        "name": "Chrome 129", //Name of the OS entry
        "platform": "chrome" //Platform of the OS entry
    },
    "deviceGroup": {
        "id": "47641750-7f17-461a-84c2-8e94fd705b20", //The device group ID
        "name": "Default" //The device group name
    }
}

{
    "endpoints": [ //A list of endpoints which should execute a scan
        "dd40830b-b103-4f9a-ae02-bbf0d792466d",
        "e7e88612-d9b1-4e2f-b248-f2fad48579e4"
    ]
}

{
    "created": [
        {
            "id": "ec09add5-a752-4b6e-b1b6-b89000252edb", //The unique ID of the action
            "tenant": {
                "id": "b8a75c7d-7492-4009-9f95-8c815551dc55" //Tenant of the mobile device
            },
            "device": {
                "id": "dd40830b-b103-4f9a-ae02-bbf0d792466d", //The ID of the mobile device
                "name": "My Android Device"
            },
            "type": "scan", //The requested action
            "state": "accepted" //The processing status of the action
        }
    ],
    "errors": {
        "failedToCreate": {
            "endpointNotFound": [ //Endpoints that were unknown to Sophos Mobile and therefore didn't receive the action
                "e7e88612-d9b1-4e2f-b248-f2fad48579e4"
            ]
        }
    }
}

{
  "items": [
    {
      "id": "47641750-7f17-461a-84c2-8e94fd705b20",
      "tenant": {
        "id": "b8a75c7d-7492-4009-9f95-8c815551dc55"
      },
      "name": "Default" //The default device group
    },
    {
      "id": "3ef0a22d-1495-42bc-acdf-1cdb7937175c",
      "tenant": {
        "id": "b8a75c7d-7492-4009-9f95-8c815551dc55"
      },
      "name": "Another group"
    },
    {
      "id": "e5264ac2-545f-45b0-a9d4-c0d6b708ba0c",
      "tenant": {
        "id": "b8a75c7d-7492-4009-9f95-8c815551dc55"
      },
      "name": "My custom device group"
    }
  ],
  "pages": {
    "current": 1,
    "size": 50,
    "maxSize": 500
  }
}

{
  "items": [
    {
      "id": "c9c9b03c-5cf7-4fe1-93bb-246afc9044d2", //The unique ID of the policy
      "tenant": {
        "id": "b8a75c7d-7492-4009-9f95-8c815551dc55" //The tenant the policy belongs to
      },
      "name": "My policy", //The unique name of the policy
      "description": "Some description for the policy", //A description of the policy
      "platform": "android", //The platform this policy applies to. Either "android" or "iOS".
      "type": "threatDefense", //The policy type
      "version": "2" //The current version of the policy
    }
  ],
  "pages": {
    "current": 1,
    "size": 50,
    "maxSize": 500
  }
}

{
  "name": "My policy", //Required. A unique name for the policy. Maximum 255 characters.
  "description": "Some description for the policy", //Optional. A description of the policy. Maximum 500 characters.
  "platform": "android", //Required. The platform this policy applies to. Either "android" or "iOS".
  "type": "threatDefense" //Required. The type of policy. Currently, only "threatDefense" is supported.
}

{
  "id": "c9c9b03c-5cf7-4fe1-93bb-246afc9044d2",
  "tenant": {
    "id": "b8a75c7d-7492-4009-9f95-8c815551dc55"
  },
  "name": "My policy",
  "description": "Some description for the policy",
  "platform": "android",
  "type": "threatDefense",
  "version": "1"
}

{
  "id": "c9c9b03c-5cf7-4fe1-93bb-246afc9044d2",
  "tenant": {
    "id": "b8a75c7d-7492-4009-9f95-8c815551dc55"
  },
  "name": "My policy",
  "description": "Some description for the policy",
  "platform": "android",
  "type": "threatDefense",
  "version": "1"
}

{
  "deviceGroup": {
    "id": "d602034d-a509-4c93-ade0-61f5b496c963", //The device group newly enrolled devices are added to
    "name": "A device group"
  },
  "ownershipType": "corporate", //The ownership type assigned to newly enrolled devices
  "androidPolicy": {
    "id": "ea1735cc-d321-4a39-a61a-7ec4a5975e1d", //The ID of the Android security policy
    "name": "My Android policy",
    "platform": "android",
    "type": "threatDefense",
    "version": "1"
  },
  "iosPolicy": {
    "id": "15539043-4ec1-4525-bf2d-646e4f5d8212", //The ID of the iOS security policy
    "name": "My iOS policy",
    "platform": "iOS",
    "type": "threatDefense",
    "version": "1"
  },
  "connectionCode": "eyJ0b2tlbiI6ImZvb28iLCJjdXN0b21lcmlkIjoiNDgyNzY5IiwidXJsIjoic21jLWRldmljZS1pZi1jbG91ZHN0YXRpb24tZXUtd2VzdC0xLnRlc3QuaHlkcmEuc29waG9zLmNvbSJ9" //The connection code used for automatic enrollment of Intercept X for Mobile
}

{
  "error": "ixmAutoEnrollmentNotConfigured",
  "correlationId": "932d23fa-67d8-4447-8172-c45b2dc5d770",
  "requestId": "e419c347-3bed-4d67-8b42-177970bcf7e5",
  "createdAt": "2026-06-15T12:55:59.972Z",
  "code": "MOBSRV0401",
  "message": "Intercept X auto-enrollment isn't configured for customer ac4738dd-18ff-4428-9532-201725732a5c"
}

{
  "deviceGroupId": "d602034d-a509-4c93-ade0-61f5b496c963", //Required. The ID of the device group to add new devices to.
  "ownershipType": "corporate", //Required. The ownership type assigned to newly enrolled devices.
  "androidPolicyId": "8ef59086-c490-4c73-a7ed-6c17e4a417ad", //Optional. The ID of an Android security policy.
  "iosPolicyId": "f78afaa2-91d5-4f1d-8696-399af29a3941" //Optional. The ID of an iOS security policy.
}

{
  "deviceGroupId": "d602034d-a509-4c93-ade0-61f5b496c963", //Required. The ID of the device group.
  "ownershipType": "corporate", //Required. The ownership type for newly enrolled devices.
  "androidPolicyId": "8ef59086-c490-4c73-a7ed-6c17e4a417ad", //Optional. The new Android security policy ID.
  "rotateConnectionCode": true //Optional. Set to true to generate a new connection code, invalidating the previous one.
}

{
  "deleted": true
}

{
  "items": [
    {
      "id": "bbe29711-209c-44a9-ba74-46de45a063cd",
      "version": "---", //The default Android version
      "name": "Android",
      "platform": "android"
    },
    {
      "id": "12f8dfdd-6921-4ec6-8b59-2257c12cb45a",
      "version": "14",
      "name": "Android 14", //The display name of the operating system
      "platform": "android",
      "majorVersion": "14" //The major version of the operating system
    },
    {
      "id": "d39770b8-2234-4b43-859d-0d59b1e8da95",
      "version": "15",
      "name": "Android 15",
      "platform": "android",
      "majorVersion": "15"
    },
    {
      "id": "13d09c35-eb63-47a1-a2b9-55fd68283748",
      "version": "8.1.0",
      "name": "Android 8.1.0",
      "platform": "android",
      "majorVersion": "8",
      "minorVersion": "1", //The minor version of the operating system
      "patchVersion": "0" //The patch version of the operating system
    },
    {
      "id": "b2a29d71-b159-421c-b567-dbfbf0dafeec",
      "version": "R", //Some Android versions use a letter instead of a number
      "name": "Android R",
      "platform": "android"
    },
    {
      "id": "3dccb022-889d-4fb8-ab9b-eaf35e27560b",
      "version": "120",
      "name": "Chrome 120",
      "platform": "chrome",
      "majorVersion": "120"
    },
    {
      "id": "9852df33-21a7-4173-9f00-976187908658",
      "version": "121",
      "name": "Chrome 121",
      "platform": "chrome",
      "majorVersion": "121"
    }
  ],
  "pages": {
    "current": 1,
    "size": 50,
    "maxSize": 500
  }
}