Favicon

You are here: Home > API Reference > Windows > Windows Enterprise Creation > Retrieve Windows enterprise configuration

Retrieve Windows enterprise configuration

Required Permission: mdm.windows.enterprise.get

Retrieve current Windows device management enterprise configuration including domain settings and branding customization for organizational enrollment.

GET
/v1/organizations/:organizationId/mdm/windows/enterprise/
Copy to clipboard

Retrieve Windows enterprise configuration

Required Permission: mdm.windows.enterprise.get

Retrieve current Windows device management enterprise configuration including domain settings and branding customization for organizational enrollment.

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

Responses

200 Response application/json
status boolean required
data object required
id string required
Unique identifier for the Windows enterprise configuration entity enabling targeted operations and relationship tracking across the platform.
Match pattern: ^[a-fA-F0-9]{24}$
domain string required
Domain identifier used for Windows device enrollment portal branding and management interface customization throughout the organization.
≤ 256 characters
updatedAt string required
Timestamp of the most recent modification to the enterprise configuration tracking changes and updates for audit purposes.
createdAt string required
Timestamp when the Windows enterprise configuration was initially created establishing the baseline for all subsequent modifications and tracking.
organizationInfo object optional
Organization identity and branding information inherited from the parent organization context providing consistent presentation across all device interactions.
id string optional
Match pattern: ^[a-fA-F0-9]{24}$
name string optional
≤ 128 characters
slug string optional
≤ 128 characters · ≥ 3 characters · Match pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]+[a-zA-Z0-9]$
store object optional
customDomain string optional
≤ 256 characters
branding object optional
logo string optional
≤ 256 characters
picture string optional
primaryColor any optional
configuration object optional
storageProvider string optional
Match pattern: ^[a-fA-F0-9]{24}$
createdBy string optional
Match pattern: ^[a-fA-F0-9]{24}$
{
    "status": true,
    "data": {
        "id": "string",
        "domain": "string",
        "updatedAt": "string",
        "createdAt": "string",
        "organizationInfo": {
            "id": "string",
            "name": "string",
            "slug": "string",
            "store": {
                "customDomain": "string"
            },
            "branding": {
                "logo": "string",
                "picture": "string",
                "primaryColor": "string"
            },
            "configuration": {
                "storageProvider": "string"
            },
            "createdBy": "string"
        }
    }
}
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"
    }
}