Get Available License Keys

Code Example #

$curl = curl_init();

$endpoint = '{{domain}}/wp-json/wclm/v3/get-license-details';
$parameters = array(
        // How many license keys to return
        'count' => '5'

        // The new status assigned to the retrieved license keys
        'status_after_retrieve' => 'unregistered'
    );

curl_setopt_array($curl, array(
     CURLOPT_URL => $endpoint,
     CURLOPT_RETURNTRANSFER => true,
     CURLOPT_MAXREDIRS => 10,
     CURLOPT_TIMEOUT => 0,
     CURLOPT_FOLLOWLOCATION => true,
     CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
     CURLOPT_CUSTOMREQUEST => 'POST',
     CURLOPT_POSTFIELDS => $parameters,
     CURLOPT_USERAGENT => $_SERVER['HTTP_USER_AGENT'],
     CURLOPT_SSL_VERIFYPEER => false,
     CURLOPT_HTTPHEADER => array(
         // Authenticated user token
         'Authorization: Bearer {{User Token}}'
     ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

API Responses #

{
    "response": {
        "licenses": [
            {
                "license_id": "479",
                "product_id": "318",
                "variation_id": "0",
                "license_key": "B65A-D921-47B1-26EC",
                "image_license_key": null,
                "license_status": "available",
                "owner_first_name": "",
                "owner_last_name": "",
                "owner_email_address": "",
                "delivre_x_times": "1",
                "remaining_delivre_x_times": "1",
                "max_instance_number": "1",
                "number_use_remaining": "1",
                "activation_date": null,
                "creation_date": "2025-03-20",
                "expiration_date": "0000-00-00",
                "valid": "0",
                "order_id": "0",
                "sold_date": "2025-03-20",
                "device_id": null,
                "subscription_id": "0",
                "pool_id": "0"
            },
            {
                "license_id": "478",
                "product_id": "318",
                "variation_id": "0",
                "license_key": "CF3B-2AEB-3D6F-3584",
                "image_license_key": null,
                "license_status": "available",
                "owner_first_name": "",
                "owner_last_name": "",
                "owner_email_address": "",
                "delivre_x_times": "1",
                "remaining_delivre_x_times": "1",
                "max_instance_number": "1",
                "number_use_remaining": "1",
                "activation_date": null,
                "creation_date": "2025-03-20",
                "expiration_date": "0000-00-00",
                "valid": "0",
                "order_id": "0",
                "sold_date": "2025-03-20",
                "device_id": null,
                "subscription_id": "0",
                "pool_id": "0"
            },
            {
                "license_id": "477",
                "product_id": "318",
                "variation_id": "0",
                "license_key": "61FD-CE6D-A4B4-16E2",
                "image_license_key": null,
                "license_status": "available",
                "owner_first_name": "",
                "owner_last_name": "",
                "owner_email_address": "",
                "delivre_x_times": "1",
                "remaining_delivre_x_times": "1",
                "max_instance_number": "1",
                "number_use_remaining": "1",
                "activation_date": null,
                "creation_date": "2025-03-20",
                "expiration_date": "0000-00-00",
                "valid": "0",
                "order_id": "0",
                "sold_date": "2025-03-20",
                "device_id": null,
                "subscription_id": "0",
                "pool_id": "0"
            },
            {
                "license_id": "476",
                "product_id": "318",
                "variation_id": "0",
                "license_key": "27E0-997B-2FC7-ABA4",
                "image_license_key": null,
                "license_status": "available",
                "owner_first_name": "",
                "owner_last_name": "",
                "owner_email_address": "",
                "delivre_x_times": "1",
                "remaining_delivre_x_times": "1",
                "max_instance_number": "1",
                "number_use_remaining": "1",
                "activation_date": null,
                "creation_date": "2025-03-20",
                "expiration_date": "0000-00-00",
                "valid": "0",
                "order_id": "0",
                "sold_date": "2025-03-20",
                "device_id": null,
                "subscription_id": "0",
                "pool_id": "0"
            },
            {
                "license_id": "475",
                "product_id": "318",
                "variation_id": "0",
                "license_key": "ECE1-E363-A30D-4633",
                "image_license_key": null,
                "license_status": "available",
                "owner_first_name": "",
                "owner_last_name": "",
                "owner_email_address": "",
                "delivre_x_times": "1",
                "remaining_delivre_x_times": "1",
                "max_instance_number": "1",
                "number_use_remaining": "1",
                "activation_date": null,
                "creation_date": "2025-03-20",
                "expiration_date": "0000-00-00",
                "valid": "0",
                "order_id": "0",
                "sold_date": "2025-03-20",
                "device_id": null,
                "subscription_id": "0",
                "pool_id": "0"
            }
        ],
        "api_timestamp": 1746386094
    },
    "signature": "private key not set"
}

WordPress’s built-in REST API responses.

{
    "code": "rest_forbidden",
    "message": "Sorry, you are not allowed to do that.",
    "data": {
        "status": 403
    }
}