# Retrieve the full configuration details of a Hello payload item

Get Windows Hello Policy payload details

**This API endpoint is deprecated**

## Endpoint

`GET /api/v1/mdm/profiles/{profile_id}/payloads/windowshellopolicy/payloaditems/{payload_id}`

## Request URL

`https://{server-hostname}:8383/api/v1/mdm/profiles/{profile_id}/payloads/windowshellopolicy/payloaditems/{payload_id}`

## Scope

`MDMDeviceMgmt.READ`

## Header

`Authorization: d92d4xxxxxxxxxxxxx15f52`

## Request Parameters

### Request Headers

- **Accept** `string` **Mandatory**  
  `application/json`

### Path Parameters

- **profile_id** `string` **Mandatory**  
  Unique identifier of the profile. Obtain from the [Create Profile](https://www.manageengine.com/products/desktop-central/help/api/onpremise/mdm-profiles-create-profile.html) or [Get Profiles](https://www.manageengine.com/products/desktop-central/help/api/onpremise/mdm-profiles-get-profile.html) response

- **payload_id** `string` **Mandatory**  
  Unique identifier of the payload item. Obtain from the [Get Payload Item IDs](https://www.manageengine.com/products/desktop-central/help/api/onpremise/windows-get-hello-payload.html) response

## Sample Request

```curl
curl --request GET \
  --url https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/windowshellopolicy/payloaditems/{payload_id} \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52'
```

## Response Parameters

### HTTP Code 200

#### Response Body — application/json

`JSON Object`

- **payload_id** `long`  
  Unique identifier of the payload item

- **tenant_id** `string`  
  Tenant Id. Default: -1

- **enable_pfw** `boolean`  
  Enable Pfw

- **allow_digits** `integer`  
  Allow Digits

- **allow_uppercase_letter** `integer`  
  Allow Uppercase Letter

- **allow_lowercase_letter** `integer`  
  Allow Lowercase Letter

- **allow_special_chars** `integer`  
  Allow Special Chars

- **min_pin_length** `integer`  
  Min Pin Length

- **max_pin_length** `integer`  
  Max Pin Length

- **enable_pin_recovery** `boolean`  
  Enable Pin Recovery

- **pin_history** `integer`  
  Pin History

- **pin_expiry** `integer`  
  Pin Expiry

- **enable_biometrics** `boolean`  
  Enable Biometrics

- **allow_security_key** `integer`  
  Allow Security Key

- **enable_device_unlock** `boolean`  
  Enable Device Unlock

- **enable_device_lock** `boolean`  
  Enable Device Lock

- **allow_companion_device** `boolean`  
  Allow Companion Device

- **allow_tpm** `boolean`  
  Allow Tpm

- **enable_anti_spoof** `string`  
  Enable Anti Spoof

- **device_unlock_config** `JSON Array`  
  Device Unlock Config

- **tfa_bluetooth** `JSON Object`  
  Tfa Bluetooth

- **tfa_wifi** `JSON Array`  
  Tfa Wifi

## Possible Response Codes

- **200** `HTTP code`

## Sample Response: HTTP 200

### Full configuration details of Hello payload item (PIN Policy Enabled)

```json
{
  "tenant_id": "749fd9b3-b71e-4210-a8ff-ea830c4c5135",
  "max_pin_length": "127",
  "payload_id": "9007199254741295",
  "allow_companion_device": false,
  "allow_uppercase_letter": "0",
  "enable_anti_spoof": false,
  "allow_special_chars": "0",
  "enable_device_unlock": false,
  "allow_lowercase_letter": "0",
  "allow_tpm": false,
  "pin_history": "0",
  "min_pin_length": "6",
  "pin_expiry": "0",
  "allow_security_key": "0",
  "enable_biometrics": false,
  "allow_digits": "0",
  "enable_pfw": true,
  "enable_device_lock": false,
  "enable_pin_recovery": false
}
```

### Full configuration details of Hello payload item (PIN Policy Disabled)

```json
{
  "tenant_id": "-1",
  "max_pin_length": "4",
  "payload_id": "9007199254741295",
  "allow_companion_device": false,
  "allow_uppercase_letter": "2",
  "enable_anti_spoof": false,
  "allow_special_chars": "2",
  "enable_device_unlock": false,
  "allow_lowercase_letter": "2",
  "allow_tpm": false,
  "pin_history": "0",
  "min_pin_length": "4",
  "pin_expiry": "0",
  "allow_security_key": "0",
  "enable_biometrics": false,
  "allow_digits": "1",
  "enable_pfw": false,
  "enable_device_lock": false,
  "enable_pin_recovery": false
}
```

### Full configuration details of Hello payload item (TFA Configured)

```json
{
  "tenant_id": "-1",
  "max_pin_length": "4",
  "payload_id": "9007199254741295",
  "allow_companion_device": false,
  "device_unlock_config": [
    {
      "factor_type": "1",
      "credential_provider_id": "1"
    },
    {
      "factor_type": "1",
      "credential_provider_id": "0"
    },
    {
      "factor_type": "2",
      "credential_provider_id": "2"
    },
    {
      "factor_type": "2",
      "credential_provider_id": "3"
    }
  ],
  "allow_uppercase_letter": "2",
  "enable_anti_spoof": false,
  "allow_special_chars": "2",
  "enable_device_unlock": true,
  "allow_lowercase_letter": "2",
  "allow_tpm": false,
  "pin_history": "0",
  "min_pin_length": "4",
  "pin_expiry": "0",
  "allow_security_key": "0",
  "tfa_bluetooth": {
    "auth_scenario": "0",
    "class_of_device": "3"
  },
  "enable_biometrics": false,
  "allow_digits": "1",
  "enable_pfw": false,
  "tfa_wifi": [
    {
      "wifi_ssid": "Dummy WiFI",
      "wifi_security_type": "5"
    }
  ],
  "enable_device_lock": false,
  "enable_pin_recovery": false
}
```

## Rate Limit

![](https://www.zohowebstatic.com/sites/zweb/images/people/ico-help.png)

**Duration:** 1 minute | **Threshold:** 120 | **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.