List Orders

List all domain orders for the authenticated organization.

Supports filtering by status and pagination. Returns order summaries including domain name, price, payment status, and order status.

Query Parameters:

• page: Page number (1-indexed, default: 1)
• page_size: Number of records per page (default: 10)
• order_status: Filter by order status (pending, ready_to_process, processing, completed, failed, cancelled)

GET /api/v1/registrar/orders

List Orders

cURL

curl --request GET \
  --url https://api.dotlet.net/api/v1/registrar/orders \
  --header 'X-API-Key: <api-key>'

200

{
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "domain_name": "<string>",
      "price": "<string>",
      "amount_paid": "<string>",
      "amount_due": "<string>",
      "fully_paid": true,
      "created_at": "2023-11-07T05:31:56Z"
    }
  ],
  "total": 123,
  "page": 123,
  "page_size": 123,
  "total_pages": 123
}

Authorizations

APIKeyHeaderHTTPBearer

X-API-Key · string · header · required

Query Parameters

page · integer · default: 1

page_size · integer · default: 10

order_status · string | null

Response

200

application/json

Successful Response

Paginated list of domain orders

items · DomainOrderSummary · object[] · required

Show child attributes

total · integer · required

page · integer · required

page_size · integer · required

total_pages · integer · required