External DocumentationTo learn more, visit the Brandsight documentation.
Parameters
| Parameter | Description |
|---|---|
| Customer ID | The ID of the Brandsight customer. |
| Includes | Optional details to be included in the response. |
| Limit | Maximum number of domains to return. Valid range is 1-500. |
| Marker | A marker domain to use as the offset in results. |
| Modified After | Filter results that were modified after the specified timestamp. |
| Modified Before | Filter results that will expire before the specified timestamp. |
| Status Groups | Domain lifecycle group statuses to filter the results by. Available options: - PENDING - Domain name is in the process of being registered or transferred in (includes PENDING_TRANSFER, PENDING_REGISTRATION).- REGISTERED - Domain name is registered (includes ACTIVE, LOCKED_REGISTRAR, PARKED, HELD_REGISTRAR, SUSPENDED).- PENDING_TERMINAL - Domain name is expired and will be removed soon (includes EXPIRED, DELETED_REDEEMABLE).- TERMINAL - Domain name has been cancelled and is not reclaimable (includes CANCELLED, FAILED, TRANSFERRED, REPOSSESSED, OWNERSHIP_CHANGED). |
| Statuses | Statuses to filter results by. Available Options: - ACTIVE - Domain name has been registered and is active.- CANCELLED - Domain name has been cancelled by the user or system and is not reclaimable.- DELETED_REDEEMABLE - Domain name is deleted but is redeemable.- EXPIRED - Domain name has expired.- FAILED - Domain name registration or transfer error.- LOCKED_REGISTRAR - Domain name is locked at the registrar; this is usually the result of a spam, abuse, etc.- PARKED - Domain name has been parked.- HELD_REGISTRAR - Domain name is held at the registrar and cannot be transferred or modified; this is usually the result of a dispute.- OWNERSHIP_CHANGED Domain name has been moved to another account.- PENDING_TRANSFER - Domain name transfer has been requested and is pending the transfer process.- PENDING_REGISTRATION - Domain name is pending registration at the registry.- REPOSSESSED - Domain name has been confiscated, this is usually the result of a chargeback, fraud, abuse, etc.- SUSPENDED - Domain name is in violation and has been suspended.- TRANSFERRED - Domain name has been transferred to another registrar. |
Example Output
[
{
"createdAt": "string",
"deletedAt": "string",
"domain": "string",
"domainId": "string",
"expirationProtected": true,
"expiresAt": "string",
"holdClient": true,
"holdRegistrar": true,
"locked": true,
"modifiedAt": "string",
"nameServers": [
"string"
],
"privacy": true,
"renewAuto": true,
"renewDeadline": "string",
"renewal": {
"currency": "USD",
"price": 0,
"renewable": true
},
"status": "ACTIVE",
"transferAwayEligibleAt": "string",
"transferProtected": true
}
]
Workflow Library Example
List Domains with Brandsight and Send Results Via Email