View TLD Reminder Settings

Retrieve the Top-Level Domain (TLD) reminder configuration for a specific resource by providing its resource_id in the path. This endpoint returns the reminder settings that are used to notify teams about upcoming domain expirations or other critical TLD-related events.

It helps ensure that domains tied to active monitoring services are not overlooked and that reminders are properly configured to allow time for renewal or compliance actions.

Use cases:

Reminder verification — Confirm whether a TLD reminder is set for a given domain and how far in advance it triggers.
Renewal planning — Audit reminder settings as part of domain renewal cycles or registrar management workflows.
Operational visibility — Ensure that all mission-critical domains have proactive alerts in place to avoid expiration-related downtime.

To adjust reminder timing or update existing settings, use the Update TLD Reminder endpoint.

Authorization: Bearer YOUR_TOKEN

Path Parameters

id string
The unique ID of the resource whose TLD reminder will be retrieved.
Example: 'c03b02ec-244f-4d2c-8f68-3910071ed5c8'

JavaScript

Response codes

const axios = require('axios');

const url = 'https://resource-query.api.pinghome.io/v1/resource/c03b02ec-244f-4d2c-8f68-3910071ed5c8/tld/reminder';

axios.get(url, {
    headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
    }
})
.then(response => {
    console.log(response.data);
})
.catch(error => {
    console.error(error);
});

ResponseThis section is used to view the possible HTTP response codes returned by the API. These codes indicate the status of a request, such as 201 (Created), 401 (Unauthorized), 409 (Conflict), or 422 (Unprocessable Entity).