Favicon

You are here: Home > API Reference > Apple > Apple Locations > Assignments admVppAsset

Assignments admVppAsset

Required Permission: mdm.apple.vppAsset.assignments

Assignments admVppAsset

GET
/v1/organizations/:organizationId/mdm/apple/enterprise/vpp/locations/:admVppLocationId/assets/assignments
Copy to clipboard

Assignments admVppAsset

Required Permission: mdm.apple.vppAsset.assignments

Assignments admVppAsset

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,}))$
admVppLocationId string
required
Match pattern: ^[a-fA-F0-9]{24}$
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
adamId string
optional
≤ 256 characters
serialNumber string
optional
≤ 256 characters
clientUserId string
optional
≤ 256 characters
sinceVersionId string
optional
≤ 256 characters

Responses

200 Response application/json
status boolean optional
data object optional
items array [object] optional
organization string optional
Match pattern: ^[a-fA-F0-9]{24}$
admEnterprise string optional
Match pattern: ^[a-fA-F0-9]{24}$
admVppLocation string optional
Match pattern: ^[a-fA-F0-9]{24}$
adamId string optional
≤ 256 characters
clientUserId string optional
≤ 256 characters
pricingParam string optional
STDQ PLUS
serialNumber string optional
≤ 256 characters
assetInfo object optional
admDeviceInfo object optional
mdmUserInfo object optional
version integer optional
≥ 0
createdAt string optional
Format: date-time
totalDocs integer optional
limit integer optional
hasPrevPage boolean optional
hasNextPage boolean optional
page integer optional
totalPages integer optional
prevPage integer optional
nextPage integer optional
lean boolean optional
{
    "status": true,
    "data": {
        "items": [
            {
                "organization": "string",
                "admEnterprise": "string",
                "admVppLocation": "string",
                "adamId": "string",
                "clientUserId": "string",
                "pricingParam": "STDQ",
                "serialNumber": "string",
                "assetInfo": {},
                "admDeviceInfo": {},
                "mdmUserInfo": {},
                "version": 0,
                "createdAt": "2024-01-01T00: 00:00Z"
            }
        ],
        "totalDocs": 0,
        "limit": 0,
        "hasPrevPage": true,
        "hasNextPage": true,
        "page": 0,
        "totalPages": 0,
        "prevPage": 0,
        "nextPage": 0,
        "lean": true
    }
}
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"
    }
}