Retrieves all managed devices along with their basic details and agent status.
https://{serverurl}/bsp/api/v1/bmp/devices
Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
Search string to filter devices by name, FQDN, or username (contains match). Example: 'laptop', 'user123'
Filter by agent installation status (comma-separated for multiple). Example: 'true', 'false'
Max results per page. Example: 50, 100, 200
Starting index for results (0-based). Example: 0, 50, 100
Cursor-based pagination token returned from previous response for fetching next page
Filter by OS platform type. Example: '1' (Windows), '2' (Mac)
curl --request GET \
--url https://appdomains/bsp/api/v1/bmp/devices \
--header 'Accept: application/json' \
--header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52'List of devices with agent details
Device details with agent information
Individual device entry
Unique device resource ID
Fully qualified domain name
Operating system name
Operating system version
Operating system platform identifier
BSP agent installation status
Unix timestamp when agent was installed
Installed BSP agent version
Username of the logged-in user
Agent installation type identifier
Bad request error when pagination parameters exceed the allowed range
Error code indicating a pagination parameter exceeds the allowed range
Message indicating the parameter value is out of range
Request URL that triggered the error
Unauthorized error code: credentials missing, expired, or invalid
Authentication failure reason
Error code indicating insufficient permissions
Message indicating insufficient privileges to access this resource
Rate limit error code returned when the API call reached threshold
Rate limit exceeded message with retry guidance
Internal server error during device operations
Message describing the server-side failure
Internal server error code
Device list
{
"devices": [
{
"agent_version": "1.0.5",
"agent_installed_time": 1704067200000,
"device_id": 999,
"platform_type": 1,
"user_name": "john.doe",
"agent_installed_type": 1,
"os_version": "10.0.19041",
"agent_status": 1,
"os_name": "Windows 10 Enterprise",
"fqdn_name": "desktop-abc123.corp.local"
}
],
"paging": {
"next": "<server-url>/api/v1/bmp/devices?skip-token=eyJ0eXBlIjoib2Zmc2V0IiwidmFsdWUiOjUwfQ"
}
}
Empty device list
{
"devices": []
}
Pagination exceeded
{
"errorCode": "COM0014",
"url": "/bsp/api/v1/bmp/devices",
"errorMsg": "ARRAY_SIZE_OUT_OF_RANGE"
}
Unauthorized
{
"errorCode": "UNAUTHORIZED",
"errorMsg": "You are not authorized to perform this action"
}
Forbidden
{
"errorCode": "FORBIDDEN",
"errorMsg": "You do not have permission to access this resource"
}
Rate limit exceeded
{
"errorCode": "RATE_LIMIT_EXCEEDED",
"errorMsg": "You have exceeded the maximum number of API calls. Please try again later."
}
Server error
{
"error_description": "Internal Server error, Please try again in a moment.",
"error_code": "COM0004"
}
![]()
Duration: 1 minute | Threshold: 60 | Lock period: 5 minutes
Duration - Time window for the threshold.
Threshold - Number of API calls allowed within the specified duration.
Lock Period - Wait time before consecutive API requests.
© 2026, Zoho Corporation Pvt. Ltd. All Rights Reserved.