Export device list to CSV format

GET

/v1/organizations/:organizationId/mdm/devices/csv

Export device list to CSV format

Required Permission: mdm.global.device.list

Generates CSV export of complete device list with all filter options applied, including policies, compliance states, and metadata for offline analysis and reporting.

Request

Add parameter in header authorization

Example: Authorization: Bearer <token>

organizationId string

required

Match pattern: ^(([a-fA-F0-9]{24})|([a-zA-Z0-9\\-]{3,}))$

page integer

optional

Page number for pagination controls starting at one enabling navigation through large devices collections efficiently.

limit integer

optional

Maximum number of devices returned per page controlling result set size for pagination and performance optimization.

sort string

optional

Sort field and direction for ordering device list results enabling customized data presentation and filtering.

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

mdmUserId string

optional

Filter parameter for MDM user identifier to retrieve devices assigned to specific user.

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

type string

optional

Device platform type indicating Android iOS Apple ecosystem or Windows for platform-specific management operations.

androidapplewindows

subType string

optional

Device enrollment classification distinguishing fully enrolled devices from pending enrollment tokens for status tracking.

deviceenrollment

showAll boolean

optional

Filter flag to include deactivated or archived devices in results bypassing default active-only filter.

policyId string

optional

Filter parameter for policy identifier to retrieve devices with specific policy assignment.

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

imei string

optional

Filter parameter for device IMEI number enabling hardware-specific device lookups.

≤ 256 characters

serialNumber string

optional

Filter parameter for device serial number for manufacturer-specific device identification.

≤ 256 characters

state string

optional

Current device lifecycle state reflecting enrollment status, provisioning progress, or deactivation for management workflows.

≤ 256 characters

onlyAdmDep boolean

optional

Filter flag to retrieve only Apple DEP-enrolled devices for corporate-owned device reporting.

name string

optional

Filter parameter for device display name enabling partial name matching in search queries.

≤ 256 characters

isCompliance boolean

optional

Filter flag to retrieve only compliant or non-compliant devices for security auditing workflows.

lastSyncError boolean

optional

Filter flag to retrieve devices with recent synchronization errors for troubleshooting purposes.

emmEnrollmentTemplateId string

optional

Filter parameter for Android enrollment template identifier to group devices by enrollment method.

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

admEnrollmentTemplateId string

optional

Filter parameter for Apple enrollment template identifier to segment devices by enrollment workflow.

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

winEnrollmentTemplateId string

optional

Filter parameter for Windows enrollment template identifier for enrollment method-based device grouping.

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

tags array

optional

Array of organizational tags for grouping devices by department, location, or custom criteria in filtering workflows.

search string

optional

Full-text search parameter matching device names, serial numbers, IMEIs, or user emails for flexible discovery.

≤ 256 characters

osVersion string

optional

Filter parameter for operating system version enabling version-specific device targeting for updates.

≤ 128 characters

availableUpdate string

optional

Filter parameter for pending OS update version identifying devices eligible for upgrade campaigns.

≤ 128 characters

networkIp string

optional

Filter parameter for device network IP address enabling network-based device discovery and segmentation.

≤ 128 characters

segmentId integer

optional

Segment identifier for scoping devices into an specific segment

expandTo string

optional

Param to include ancestor or child related entities

ancestorschildren

deviceAudiences array

optional

Responses

{
  "type": "object",
  "properties": {}
}

401 Response application/json

status boolean optional

false

error object optional

code number optional

4001

message string optional

Unauthorized

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

404 Response application/json

status boolean optional

false

error object optional

code number optional

3001

message string optional

Entity not found

{
    "status": false,
    "error": {
        "code": 3001,
        "message": "Entity not found"
    }
}