Get list of device audiences

GET

/v1/organizations/:organizationId/mdm/device-audiences/

Get list of device audiences

Required Permission: mdm.global.deviceAudience.list

Get list of device audiences

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

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))?$

name string

optional

≤ 256 characters

mdmAutomationRuleId string

optional

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

segmentId integer

optional

expandTo string

optional

ancestorschildren

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}$

name string required

≤ 256 characters

description string optional

≤ 256 characters

createdAt string optional

updatedAt string optional

selectors object required

deviceGroups array [array] required

mdmUserGroups array [array] required

emmDeviceIds array [string] required

admDeviceIds array [string] required

winDeviceIds array [string] required

mdmUserIds array [string] required

serialNumbers array [string] required

segmentId integer optional

≥ 0 · ≤ 9007199254740991

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",
                "name": "string",
                "description": "string",
                "createdAt": "string",
                "updatedAt": "string",
                "selectors": {
                    "deviceGroups": [
                        [
                            "string"
                        ]
                    ],
                    "mdmUserGroups": [
                        [
                            "string"
                        ]
                    ],
                    "emmDeviceIds": [
                        "string"
                    ],
                    "admDeviceIds": [
                        "string"
                    ],
                    "winDeviceIds": [
                        "string"
                    ],
                    "mdmUserIds": [
                        "string"
                    ],
                    "serialNumbers": [
                        "string"
                    ]
                },
                "segmentId": 0
            }
        ],
        "totalDocs": 0,
        "limit": 0,
        "hasPrevPage": true,
        "hasNextPage": true,
        "page": 0,
        "totalPages": 0,
        "prevPage": 0,
        "nextPage": 0
    }
}

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"
    }
}

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"
    }
}