{ "variable": [ { "id": "baseUrl", "key": "baseUrl", "type": "string", "name": "string", "value": "https:\/\/api.elitedomains.de" } ], "info": { "name": "ELITEDOMAINS API Documentation", "_postman_id": "dc18c54c-75d6-48ac-a689-3a9bc1257b8d", "description": "The ELITEDOMAINS API allows you to manage domains, handles, and catcher orders programmatically through a simple REST API.", "schema": "https:\/\/schema.getpostman.com\/json\/collection\/v2.1.0\/collection.json" }, "item": [ { "name": "Catcher Management", "description": "", "item": [ { "name": "List all catcher orders", "request": { "url": { "host": "{{baseUrl}}", "path": "catcher", "query": [ { "key": "page", "value": "1", "description": "The page number for pagination.", "disabled": false }, { "key": "per_page", "value": "500", "description": "Number of results per page. Default: 500, Max: 500.", "disabled": false }, { "key": "tags", "value": "priority", "description": "Filter by tags (comma-separated tag names, e.g. `priority,short`). An order must have all listed tags.", "disabled": false }, { "key": "tld", "value": "de", "description": "Filter by TLD (comma-separated, e.g. `de,com`).", "disabled": false }, { "key": "order_by", "value": "dropdate_at", "description": "Field to order by. `created_at` sorts by when this catch cycle started (kept as the default for backward compatibility). `queued_at` sorts by when you personally added the domain to your catcher \u2014 the same value the listing returns as `created_at`. Default: `created_at`. Options: `created_at`, `queued_at`, `price`, `status`, `dropdate_at`, `tags`.", "disabled": false }, { "key": "order_direction", "value": "desc", "description": "Order direction. Default: `desc`. Options: `asc`, `desc`.", "disabled": false } ], "raw": "{{baseUrl}}\/catcher?page=1&per_page=500&tags=priority&tld=de&order_by=dropdate_at&order_direction=desc" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieve a paginated list of all domain catcher orders in your account.\n\nRequires a token with the `catcher:read` scope (read access to Catcher)." }, "response": [ { "header": [], "code": 200, "body": "{\n \"current_page\": 1,\n \"per_page\": 500,\n \"data\": [\n {\n \"name\": \"example.de\",\n \"status\": \"rgp\",\n \"users\": 3,\n \"price\": 5,\n \"dropdate_at\": \"2024-03-15\",\n \"created_at\": \"2024-03-10 14:30:00\",\n \"tags\": [\"tag1\", \"tag2\"],\n \"note\": \"Backorder for a client, budget approved.\"\n }\n ]\n}", "name": "Success" } ] }, { "name": "List catcher filter options", "request": { "url": { "host": "{{baseUrl}}", "path": "catcher\/filters", "query": [], "raw": "{{baseUrl}}\/catcher\/filters" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieve the tags and TLDs your catcher orders can be filtered by via `GET \/catcher`, along with how many orders currently match each option.\n\nRequires a token with the `catcher:read` scope (read access to Catcher)." }, "response": [ { "header": [], "code": 200, "body": "{\n \"tags\": [\n {\"name\": \"Priority\", \"slug\": \"priority\", \"count\": 3}\n ],\n \"tlds\": [\n {\"tld\": \"de\", \"count\": 12}\n ]\n}", "name": "Success" } ] }, { "name": "Get catcher domain info", "request": { "url": { "host": "{{baseUrl}}", "path": "catcher\/info", "query": [ { "key": "name", "value": "example.de", "description": "The domain name.", "disabled": false } ], "raw": "{{baseUrl}}\/catcher\/info?name=example.de" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieve status information for any domain in the catcher, including the number of users competing for it, the current status and the expected drop date. The domain does not need to be in your own catcher orders.\n\nRequires a token with the `catcher:read` scope (read access to Catcher)." }, "response": [ { "header": [], "code": 200, "body": "{\n \"name\": \"example.de\",\n \"status\": \"rgp\",\n \"users\": 3,\n \"dropdate_at\": \"2024-03-15 00:00:00\"\n}", "name": "Success" }, { "header": [], "code": 400, "body": "{\"message\": \"Domain name is missing\", \"name\": null}", "name": "Missing domain name" }, { "header": [], "code": 404, "body": "{\"message\": \"Domain not found\", \"name\": \"example.de\"}", "name": "Domain not in catcher" } ] }, { "name": "Add domain to catcher", "request": { "url": { "host": "{{baseUrl}}", "path": "catcher", "query": [], "raw": "{{baseUrl}}\/catcher" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"example.de\",\"price\":10}" }, "description": "Add a new domain to the RGP (Redemption Grace Period) catcher. Successfully caught domains will be registered using your default handle configuration.\n\nIf the domain is already in your catcher orders, the price can be updated instead by passing a different `price` value.\n\nThis endpoint may execute registry operations and counts against your API rate limit.\n\nRequires a token with the `catcher:write` scope (write access to Catcher)." }, "response": [ { "header": [], "code": 200, "body": "{\"message\": \"Domain added to catcher\", \"name\": \"example.de\"}", "name": "Success" }, { "header": [], "code": 200, "body": "{\"message\": \"Price updated to 10\u20ac\", \"name\": \"example.de\"}", "name": "Price updated" }, { "header": [], "code": 400, "body": "{\"message\": \"Domain name is missing\"}", "name": "Missing domain name" }, { "header": [], "code": 400, "body": "{\"message\": \"Domain name is invalid\"}", "name": "Invalid domain" }, { "header": [], "code": 400, "body": "{\"message\": \"The domain catcher is only available for .de domains\"}", "name": "Unsupported TLD" }, { "header": [], "code": 400, "body": "{\"message\": \"Default handle in your accounts settings required\"}", "name": "Missing handle" }, { "header": [], "code": 403, "body": "{\"message\": \"Your catcher access is currently locked. Please check your invoices or contact support.\"}", "name": "Account locked" }, { "header": [], "code": 405, "body": "{\"message\": \"Catcher Create not possible between 2:00 and 4:00am\"}", "name": "Droptime restriction" }, { "header": [], "code": 409, "body": "{\"message\": \"Domain already added to catcher with price 5\u20ac\"}", "name": "Already added" } ] }, { "name": "Remove domain from catcher", "request": { "url": { "host": "{{baseUrl}}", "path": "catcher", "query": [], "raw": "{{baseUrl}}\/catcher" }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"example.de\"}" }, "description": "Remove a domain from your catcher order list.\n\nRequires a token with the `catcher:write` scope (write access to Catcher)." }, "response": [ { "header": [], "code": 200, "body": "{\"message\": \"Domain deleted\", \"name\": \"example.de\"}", "name": "Success" }, { "header": [], "code": 400, "body": "{\"message\": \"Domain name is missing\"}", "name": "Missing domain name" }, { "header": [], "code": 404, "body": "{\"message\": \"Domain not found\"}", "name": "Domain not found" }, { "header": [], "code": 405, "body": "{\"message\": \"Catcher Delete not possible between 2:00 and 4:00am\"}", "name": "Droptime restriction" } ] } ] }, { "name": "Domain Management", "description": "", "item": [ { "name": "List all domains", "request": { "url": { "host": "{{baseUrl}}", "path": "domains", "query": [ { "key": "page", "value": "1", "description": "The page number for pagination.", "disabled": false }, { "key": "per_page", "value": "500", "description": "Number of results per page. Default: 500, Max: 500.", "disabled": false }, { "key": "tags", "value": "premium,aged", "description": "Filter by tags (comma-separated tag names, e.g. `premium,aged`). A domain must have all listed tags.", "disabled": false }, { "key": "tld", "value": "de", "description": "Filter by TLD (comma-separated, e.g. `de,com`).", "disabled": false }, { "key": "order_by", "value": "created_at", "description": "Field to order by. Default: `created_at`. Options: `created_at`, `name`, `paid_until`, `expires_at`, `auto_expire`, `handle`, `tags`.", "disabled": false }, { "key": "order_direction", "value": "desc", "description": "Order direction. Default: `desc`. Options: `asc`, `desc`.", "disabled": false } ], "raw": "{{baseUrl}}\/domains?page=1&per_page=500&tags=premium%2Caged&tld=de&order_by=created_at&order_direction=desc" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieve a paginated list of all domains in your account.\n\nRequires a token with the `domains:read` scope (read access to Domains)." }, "response": [ { "header": [], "code": 200, "body": "{\n \"current_page\": 1,\n \"per_page\": 500,\n \"data\": [\n {\n \"name\": \"example.de\",\n \"redirector_settings\": {\"type\": \"landing\", \"method\": \"redirect_sale_page\"},\n \"authinfo\": \"E-Hc$f3xx\",\n \"auto_expire\": \"2024-12-31\",\n \"paid_until\": \"2024-12-31\",\n \"expires_at\": \"2025-01-01T00:00:00.000000Z\",\n \"created_at\": \"2023-01-15T10:30:00.000000Z\",\n \"note\": \"Renew early, buyer interest from 2023.\"\n }\n ]\n}", "name": "Success" } ] }, { "name": "List domain filter options", "request": { "url": { "host": "{{baseUrl}}", "path": "domains\/filters", "query": [], "raw": "{{baseUrl}}\/domains\/filters" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieve the tags and TLDs your domains can be filtered by via `GET \/domains`, along with how many domains currently match each option.\n\nRequires a token with the `domains:read` scope (read access to Domains)." }, "response": [ { "header": [], "code": 200, "body": "{\n \"tags\": [\n {\"name\": \"Premium\", \"slug\": \"premium\", \"count\": 12},\n {\"name\": \"Aged\", \"slug\": \"aged\", \"count\": 4}\n ],\n \"tlds\": [\n {\"tld\": \"de\", \"count\": 340},\n {\"tld\": \"com\", \"count\": 58}\n ]\n}", "name": "Success" } ] }, { "name": "List TLD prices", "request": { "url": { "host": "{{baseUrl}}", "path": "domains\/prices", "query": [ { "key": "tld", "value": "de", "description": "Filter the result by a single TLD. The leading dot is optional.", "disabled": false } ], "raw": "{{baseUrl}}\/domains\/prices?tld=de" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieve the prices for all top-level domains (TLDs) available for registration. All prices are net (excluding VAT) in EUR and rounded to up to 3 decimal places.\n\nThe `price` object holds the price currently valid for your account. It may be lower than the standard price because of an active promotion or because an individual price has been negotiated for your account. The `interval` object states the billing interval each `price` value is quoted for: `yearly`, `monthly` (e.g. some accounts are billed monthly for .de) or `one_time`. The `original_price` object holds the standard yearly list price without any promotions or individual pricing \u2014 it is always yearly, even when `interval` reports a different cadence for `price` (e.g. a negotiated monthly .de renew price), so do not divide `price` by `original_price` to derive a discount unless `interval` is `yearly`. The `custom` object indicates, per price type, whether an individual price is configured for your account that deviates from the standard price.\n\nA price may be `null` when the corresponding action is not offered for a TLD.\n\nRequires a token with the `domains:read` scope (read access to Domains)." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"tld\": \"de\",\n \"price\": {\"reg\": 5, \"transfer\": 5, \"renew\": 5, \"restore\": 80},\n \"interval\": {\"reg\": \"yearly\", \"transfer\": \"yearly\", \"renew\": \"yearly\", \"restore\": \"yearly\"},\n \"original_price\": {\"reg\": 5, \"transfer\": 5, \"renew\": 5, \"restore\": 80},\n \"custom\": {\"reg\": false, \"transfer\": false, \"renew\": false, \"restore\": false}\n }\n ]\n}", "name": "Success" } ] }, { "name": "Register or transfer a domain", "request": { "url": { "host": "{{baseUrl}}", "path": "domains", "query": [], "raw": "{{baseUrl}}\/domains" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"example.de\",\"authinfo\":\"E-Hc$f3xx\",\"handle_id\":123,\"period\":12,\"redirector_settings\":{\"type\":\"landing\",\"method\":\"redirect_sale_page\",\"url\":\"https:\\\/\\\/example.com\",\"ns\":[\"ns1.example.com\",\"ns2.example.com\"],\"dns\":[{\"type\":\"A\",\"name\":\"@\",\"value\":\"192.168.1.1\",\"prio\":10,\"ttl\":3600}],\"options\":{\"dnssec-active\":\"false\",\"dnssec-key\":\"AwEAAa...\",\"dnssec-algorithm\":\"13\",\"dnssec-flags\":\"257\",\"redirect-active\":\"false\",\"redirect-method\":\"301\",\"redirect-url\":\"https:\\\/\\\/example.com\"}}}" }, "description": "Register a new domain or transfer an existing domain to your account. Domains will be created using your default redirector and handle configuration.\n\nAll TLDs from the price list (`GET \/domains\/prices`) are supported. Use `GET \/domains\/order\/check`\nto preview the required action, available periods and costs for a domain beforehand.\n\nPaid actions are charged instantly to your stored payment method (credit card or PayPal) unless your\naccount uses monthly invoicing for the TLD. If the payment cannot be authorized the order is rejected.\nFor instantly billed orders the response contains a `payment` field: `captured` (charged), `authorized`\n(the order succeeded but the charge is still pending \u2014 no action required), `canceled` (the order\nfailed, nothing was charged) or `not_required` (free of charge, e.g. fully discounted).\n\nTransfers of some TLDs (e.g. most gTLDs) do not complete immediately; in that case the response is\n`Domain transfer initiated` and the transfer continues in the background.\n\nThis endpoint may execute registry operations and counts against your API rate limit.\n\nRequires a token with the `domains:write` scope (write access to Domains)." }, "response": [ { "header": [], "code": 200, "body": "{\"message\": \"Domain registered successfully\", \"name\": \"example.de\", \"period\": 12, \"payment\": \"captured\"}", "name": "Domain registered" }, { "header": [], "code": 200, "body": "{\"message\": \"Domain transferred successfully\", \"name\": \"example.de\", \"period\": 12, \"payment\": \"captured\"}", "name": "Domain transferred" }, { "header": [], "code": 200, "body": "{\"message\": \"Domain transfer initiated\", \"name\": \"example.com\", \"period\": 12, \"payment\": \"captured\"}", "name": "Transfer initiated" }, { "header": [], "code": 200, "body": "{\"message\": \"Domain registered successfully\", \"name\": \"example.com\", \"period\": 12, \"payment\": \"authorized\", \"payment_warning\": \"The payment could not be captured yet and remains authorized. No action is required; the charge will be settled by us.\"}", "name": "Registered, capture pending" }, { "header": [], "code": 400, "body": "{\"message\": \"Domain name is missing\"}", "name": "Missing domain name" }, { "header": [], "code": 400, "body": "{\"message\": \"Domain name is invalid\"}", "name": "Invalid domain" }, { "header": [], "code": 400, "body": "{\"message\": \"This TLD is not supported\"}", "name": "Unsupported TLD" }, { "header": [], "code": 400, "body": "{\"message\": \"Invalid period. Allowed values (months): 12, 24, 36\", \"allowed_periods\": [12, 24, 36]}", "name": "Invalid period" }, { "header": [], "code": 400, "body": "{\"message\": \"Authcode invalid\"}", "name": "Invalid authcode" }, { "header": [], "code": 400, "body": "{\"message\": \"Default handle in your accounts sale settings required\"}", "name": "Missing handle" }, { "header": [], "code": 402, "body": "{\"message\": \"An instant payment method (credit card or PayPal) is required for this order. Please add one in your billing settings.\"}", "name": "No instant payment method" }, { "header": [], "code": 402, "body": "{\"message\": \"Payment could not be authorized. Please check your payment method.\"}", "name": "Payment not authorized" }, { "header": [], "code": 403, "body": "{\"message\": \"The request was rejected by the registry\"}", "name": "Registry error" }, { "header": [], "code": 409, "body": "{\"message\": \"Domain already registered\"}", "name": "Already registered" }, { "header": [], "code": 409, "body": "{\"message\": \"Domain already in your account\"}", "name": "Already in account" } ] }, { "name": "Update domain tags", "request": { "url": { "host": "{{baseUrl}}", "path": "domains\/tags", "query": [], "raw": "{{baseUrl}}\/domains\/tags" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"example.de\",\"tags\":[\"premium\",\"aged\",\"brandable\"]}" }, "description": "Add or update tags for a specific domain in your portfolio. Tags help organize and categorize your domains.\n\nRequires a token with the `domains:write` scope (write access to Domains)." }, "response": [ { "header": [], "code": 200, "body": "{\n \"tags\": [\"premium\", \"aged\", \"brandable\"],\n \"message\": \"Tags saved.\"\n}", "name": "Success" }, { "header": [], "code": 400, "body": "{\"message\": \"Domain name is invalid\"}", "name": "Invalid domain" }, { "header": [], "code": 404, "body": "{\"message\": \"Domain not found\"}", "name": "Domain not found" } ] }, { "name": "Check domain availability", "request": { "url": { "host": "{{baseUrl}}", "path": "domains\/check", "query": [ { "key": "name", "value": "example.de", "description": "The domain name to check.", "disabled": false } ], "raw": "{{baseUrl}}\/domains\/check?name=example.de" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Check the registry status of a domain. The `message` field contains the\ncurrent status. The most common values are `free` (available for registration)\nand `connect` (already registered). Other registry statuses such as\n`redemptionPeriod`, `transfer_lock` or `transit` may also be returned.\n\nAll TLDs from the price list (`GET \/domains\/prices`) are supported.\n\nThe response additionally contains the same order preview fields as\n`GET \/domains\/order\/check` (`action`, `periods`, `price`, `billing`, ...);\nsee that endpoint for their documentation. `message` always contains the\nplain registry status.\n\nThis endpoint may execute registry operations and counts against your API rate limit.\n\nRequires a token with the `domains:read` scope (read access to Domains)." }, "response": [ { "header": [], "code": 200, "body": "{\n \"name\": \"example.de\",\n \"message\": \"free\",\n \"tld\": \"de\",\n \"status\": \"free\",\n \"action\": \"register\",\n \"periods\": [{\"months\": 12, \"price\": 5, \"price_gross\": 5.95}],\n \"default_period\": 12,\n \"price\": 5,\n \"price_gross\": 5.95,\n \"tax_rate\": 19,\n \"billing\": \"instant\",\n \"instant_payment_method_available\": true\n}", "name": "Domain available" }, { "header": [], "code": 200, "body": "{\n \"name\": \"example.de\",\n \"message\": \"connect\",\n \"tld\": \"de\",\n \"status\": \"connect\",\n \"action\": \"transfer\",\n \"authinfo_required\": true,\n \"periods\": [{\"months\": 12, \"price\": 5, \"price_gross\": 5.95}],\n \"default_period\": 12,\n \"price\": 5,\n \"price_gross\": 5.95,\n \"tax_rate\": 19,\n \"billing\": \"instant\",\n \"instant_payment_method_available\": true\n}", "name": "Domain registered" }, { "header": [], "code": 400, "body": "{\"message\": \"Domain name is missing\"}", "name": "Missing domain name" }, { "header": [], "code": 400, "body": "{\"message\": \"Domain name is invalid\"}", "name": "Invalid domain" }, { "header": [], "code": 400, "body": "{\"message\": \"This TLD is not supported\"}", "name": "Unsupported TLD" } ] }, { "name": "Check domain order options", "request": { "url": { "host": "{{baseUrl}}", "path": "domains\/order\/check", "query": [ { "key": "name", "value": "example.com", "description": "The domain name to check.", "disabled": false } ], "raw": "{{baseUrl}}\/domains\/order\/check?name=example.com" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Preview what an order for a domain would look like before placing it via `POST \/domains`:\nthe current registry status, the resulting action (`register` or `transfer`), the available\nperiods with their cost and how the order would be billed.\n\n`price` values are net in EUR; `price_gross` includes VAT at your account's `tax_rate`\nand is the amount an instant payment actually charges.\n\n`billing` is `instant` when the order is charged immediately to your stored payment\nmethod (credit card or PayPal) and `monthly_invoice` when it is added to your collective\ninvoice. For instant billing, `instant_payment_method_available` indicates whether a\npayment method is stored in your account's billing settings.\n\nFor transfers the price is independent of the period; the period only determines the\nadded runtime (some TLDs do not allow choosing a period on transfer, then `periods` is empty).\n\nThis endpoint may execute registry operations and counts against your API rate limit.\n\nRequires a token with the `domains:read` scope (read access to Domains)." }, "response": [ { "header": [], "code": 200, "body": "{\n \"name\": \"example.com\",\n \"message\": \"Domain can be registered\",\n \"tld\": \"com\",\n \"status\": \"free\",\n \"action\": \"register\",\n \"periods\": [{\"months\": 12, \"price\": 9.5, \"price_gross\": 11.31}, {\"months\": 24, \"price\": 19, \"price_gross\": 22.61}],\n \"default_period\": 12,\n \"price\": 9.5,\n \"price_gross\": 11.31,\n \"tax_rate\": 19,\n \"billing\": \"instant\",\n \"instant_payment_method_available\": true\n}", "name": "Available for registration" }, { "header": [], "code": 200, "body": "{\n \"name\": \"example.com\",\n \"message\": \"Domain can be transferred\",\n \"tld\": \"com\",\n \"status\": \"connect\",\n \"action\": \"transfer\",\n \"authinfo_required\": true,\n \"periods\": [{\"months\": 12, \"price\": 9.5, \"price_gross\": 11.31}],\n \"default_period\": 12,\n \"price\": 9.5,\n \"price_gross\": 11.31,\n \"tax_rate\": 19,\n \"billing\": \"instant\",\n \"instant_payment_method_available\": true\n}", "name": "Transferable" }, { "header": [], "code": 200, "body": "{\n \"name\": \"example.com\",\n \"message\": \"Domain can currently not be ordered\",\n \"tld\": \"com\",\n \"status\": \"transfer_lock\",\n \"action\": null\n}", "name": "Not orderable" }, { "header": [], "code": 400, "body": "{\"message\": \"Domain name is missing\"}", "name": "Missing domain name" }, { "header": [], "code": 400, "body": "{\"message\": \"Domain name is invalid\"}", "name": "Invalid domain" }, { "header": [], "code": 400, "body": "{\"message\": \"This TLD is not supported\"}", "name": "Unsupported TLD" } ] }, { "name": "Update a domain", "request": { "url": { "host": "{{baseUrl}}", "path": "domains", "query": [], "raw": "{{baseUrl}}\/domains" }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"example.de\",\"redirector_settings\":{\"type\":\"landing\",\"method\":\"redirect_sale_page\",\"url\":\"https:\\\/\\\/example.com\",\"ns\":[\"ns1.example.com\",\"ns2.example.com\"],\"dns\":[{\"type\":\"A\",\"name\":\"@\",\"value\":\"192.168.1.1\",\"prio\":10,\"ttl\":3600}],\"options\":{\"dnssec-active\":\"false\",\"dnssec-key\":\"AwEAAa...\",\"dnssec-algorithm\":\"13\",\"dnssec-flags\":\"257\",\"redirect-active\":\"false\",\"redirect-method\":\"301\",\"redirect-url\":\"https:\\\/\\\/example.com\"}},\"handle_id\":1234}" }, "description": "Update domain settings such as redirector configuration or handle assignment.\n\nThis endpoint may execute registry operations and counts against your API rate limit.\n\nRequires a token with the `domains:write` scope (write access to Domains)." }, "response": [ { "header": [], "code": 200, "body": "{\"message\": \"Domain updated\"}", "name": "Success" }, { "header": [], "code": 400, "body": "{\"message\": \"Domain name is missing\"}", "name": "Missing domain name" }, { "header": [], "code": 400, "body": "{\"message\": \"Validation error details\"}", "name": "Validation error" }, { "header": [], "code": 403, "body": "{\"message\": \"The request was rejected by the registry\"}", "name": "Registry error" }, { "header": [], "code": 404, "body": "{\"message\": \"Domain not found\"}", "name": "Domain not found" }, { "header": [], "code": 404, "body": "{\"message\": \"Handle not found\"}", "name": "Handle not found" } ] }, { "name": "Delete or transit a domain", "request": { "url": { "host": "{{baseUrl}}", "path": "domains", "query": [], "raw": "{{baseUrl}}\/domains" }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"example.de\",\"transit\":0}" }, "description": "Delete a domain from your account or put it into DENIC transit state.\nTransit is a DENIC concept and therefore only available for `.de` domains.\n\nThis endpoint may execute registry operations and counts against your API rate limit.\n\nRequires a token with the `domains:write` scope (write access to Domains)." }, "response": [ { "header": [], "code": 200, "body": "{\"message\": \"Domain deleted\", \"name\": \"example.de\"}", "name": "Domain deleted" }, { "header": [], "code": 200, "body": "{\"message\": \"Domain put in transit\", \"name\": \"example.de\"}", "name": "Domain in transit" }, { "header": [], "code": 400, "body": "{\"message\": \"Domain name is missing\"}", "name": "Missing domain name" }, { "header": [], "code": 403, "body": "{\"message\": \"The request was rejected by the registry\"}", "name": "Registry error" }, { "header": [], "code": 403, "body": "{\"message\": \"Transit not supported.\"}", "name": "Transit not supported" }, { "header": [], "code": 404, "body": "{\"message\": \"Domain not found\"}", "name": "Domain not found" } ] }, { "name": "Get domain AuthInfo code", "request": { "url": { "host": "{{baseUrl}}", "path": "domains\/authinfo", "query": [ { "key": "name", "value": "example.de", "description": "The domain name.", "disabled": false } ], "raw": "{{baseUrl}}\/domains\/authinfo?name=example.de" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieve the AuthInfo\/transfer code for a domain. If none exists, a new one will be generated.\n\nThis endpoint may execute registry operations and counts against your API rate limit.\n\nRequires a token with the `domains:write` scope (write access to Domains)." }, "response": [ { "header": [], "code": 200, "body": "{\n \"message\": \"Authcode exists\",\n \"name\": \"example.de\",\n \"authinfo\": \"EDxHc$f3xx\",\n \"expires_at\": \"07.04.2024 21:34:35\"\n}", "name": "Success" }, { "header": [], "code": 400, "body": "{\"message\": \"Domain name is missing\"}", "name": "Missing domain name" }, { "header": [], "code": 403, "body": "{\"message\": \"The request was rejected by DENIC\"}", "name": "Registry error" }, { "header": [], "code": 404, "body": "{\"message\": \"Domain not found\"}", "name": "Domain not found" } ] }, { "name": "Check AuthInfo2 availability", "request": { "url": { "host": "{{baseUrl}}", "path": "domains\/authinfo2\/check", "query": [ { "key": "name", "value": "example.de", "description": "The domain name to check.", "disabled": false } ], "raw": "{{baseUrl}}\/domains\/authinfo2\/check?name=example.de" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Check if an AuthInfo2 letter can be ordered for a `.de` domain via DENIC. Only available for accounts\nthat use monthly invoicing (Sammelrechnung). AuthInfo2 is a DENIC concept and therefore only\navailable for `.de` domains.\n\nThis endpoint may execute registry operations and counts against your API rate limit.\n\nRequires a token with the `domains:read` scope (read access to Domains)." }, "response": [ { "header": [], "code": 200, "body": "{\n \"name\": \"example.de\",\n \"available\": true,\n \"message\": \"AuthInfo2 can be ordered\"\n}", "name": "Can be ordered" }, { "header": [], "code": 200, "body": "{\n \"name\": \"example.de\",\n \"available\": false,\n \"message\": \"AuthInfo2 cannot be ordered for this domain\"\n}", "name": "Not available" }, { "header": [], "code": 400, "body": "{\"message\": \"Domain name is missing\"}", "name": "Missing domain name" }, { "header": [], "code": 400, "body": "{\"message\": \"Domain name is invalid\"}", "name": "Invalid domain" }, { "header": [], "code": 400, "body": "{\"message\": \"AuthInfo2 is only available for .de domains\"}", "name": "Unsupported TLD" }, { "header": [], "code": 403, "body": "{\"message\": \"AuthInfo2 ordering via API requires monthly invoice billing (Sammelrechnung)\"}", "name": "Not a monthly invoice account" } ] }, { "name": "Order AuthInfo2", "request": { "url": { "host": "{{baseUrl}}", "path": "domains\/authinfo2", "query": [], "raw": "{{baseUrl}}\/domains\/authinfo2" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"example.de\",\"sandbox\":\"0\"}" }, "description": "Order an AuthInfo2 letter from DENIC for a `.de` domain. Only available for accounts that use monthly\ninvoicing (Sammelrechnung); the order is added to the next collective invoice. A confirmation email\nis sent on success. AuthInfo2 is a DENIC concept and therefore only available for `.de` domains.\n\nThis endpoint may execute registry operations and counts against your API rate limit.\n\nRequires a token with the `domains:write` scope (write access to Domains)." }, "response": [ { "header": [], "code": 200, "body": "{\n \"name\": \"example.de\",\n \"message\": \"AuthInfo2 letter for example.de has been ordered and will be sent within 1-2 business days.\"\n}", "name": "Ordered" }, { "header": [], "code": 200, "body": "{\n \"name\": \"example.de\",\n \"message\": \"AuthInfo2 would be ordered (sandbox mode)\"\n}", "name": "Sandbox" }, { "header": [], "code": 400, "body": "{\"message\": \"Domain name is missing\"}", "name": "Missing domain name" }, { "header": [], "code": 400, "body": "{\"message\": \"Domain name is invalid\"}", "name": "Invalid domain" }, { "header": [], "code": 400, "body": "{\"message\": \"AuthInfo2 is only available for .de domains\"}", "name": "Unsupported TLD" }, { "header": [], "code": 400, "body": "{\"message\": \"AuthInfo2 cannot be ordered for this domain\"}", "name": "Not orderable" }, { "header": [], "code": 403, "body": "{\"message\": \"AuthInfo2 ordering via API requires monthly invoice billing (Sammelrechnung)\"}", "name": "Not a monthly invoice account" }, { "header": [], "code": 403, "body": "{\"message\": \"There is a problem with your payment method. Please contact support.\"}", "name": "Payment problem" } ] }, { "name": "Add domain to Sedo marketplace", "request": { "url": { "host": "{{baseUrl}}", "path": "domains\/sedo", "query": [], "raw": "{{baseUrl}}\/domains\/sedo" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"example.de\",\"price\":1500}" }, "description": "List a domain on the Sedo marketplace with a specified price. The domain will be configured for Paynow transactions.\n\nRequires a token with the `domains:write` scope (write access to Domains)." }, "response": [ { "header": [], "code": 200, "body": "{\"message\": \"SEDO-Domain added or updated successfully\", \"name\": \"example.de\"}", "name": "Success" }, { "header": [], "code": 400, "body": "{\"message\": \"Domain name is missing\"}", "name": "Missing domain name" }, { "header": [], "code": 400, "body": "{\"message\": \"Price is required and must be greater than 0\"}", "name": "Invalid price" }, { "header": [], "code": 400, "body": "{\"message\": \"Domain name is invalid\"}", "name": "Invalid domain" }, { "header": [], "code": 404, "body": "{\"message\": \"Domain not found in your inventory\"}", "name": "Domain not found" }, { "header": [], "code": 500, "body": "{\"message\": \"An error occurred while processing the SEDO task\"}", "name": "Server error" } ] } ] }, { "name": "Domain Offers", "description": "", "item": [ { "name": "List all domain offers", "request": { "url": { "host": "{{baseUrl}}", "path": "offers", "query": [ { "key": "page", "value": "1", "description": "The page number for pagination.", "disabled": false }, { "key": "per_page", "value": "50", "description": "Number of results per page. Default: 50, Max: 500.", "disabled": false }, { "key": "type", "value": "paynow", "description": "Filter by offer type. Options: `paynow`, `4sale`.", "disabled": false }, { "key": "status", "value": "verified", "description": "Filter by status. Options: `verified`, `hold`, `not_configured`, `unverified`, `inactive`, `deconnect`.", "disabled": false }, { "key": "is_internal", "value": "1", "description": "Filter by internal domains (true) or external domains (false).", "disabled": false }, { "key": "template", "value": "slim", "description": "Filter by template name.", "disabled": false }, { "key": "min_price", "value": "99", "description": "Minimum price filter.", "disabled": false }, { "key": "max_price", "value": "5000", "description": "Maximum price filter.", "disabled": false }, { "key": "min_visitors", "value": "10", "description": "Minimum visitors in the last 30 days.", "disabled": false }, { "key": "tags", "value": "premium,short", "description": "Filter by tags (comma-separated tag names, e.g. `premium,short`). An offer must have all listed tags.", "disabled": false }, { "key": "tld", "value": "de", "description": "Filter by TLD (comma-separated, e.g. `de,com`).", "disabled": false }, { "key": "order_by", "value": "visitors", "description": "Field to order by. Default: `created_at`. Options: `created_at`, `name`, `price`, `visitors`, `leads`, `trend`, `color`, `template`, `status`, `tags`.", "disabled": false }, { "key": "order_direction", "value": "desc", "description": "Order direction. Default: `desc`. Options: `asc`, `desc`.", "disabled": false } ], "raw": "{{baseUrl}}\/offers?page=1&per_page=50&type=paynow&status=verified&is_internal=1&template=slim&min_price=99&max_price=5000&min_visitors=10&tags=premium%2Cshort&tld=de&order_by=visitors&order_direction=desc" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieve a paginated list of all sale pages (domain offers) in your account with relevant data including status, pricing, visitors, leads, and template information.\n\nRequires a token with the `offers:read` scope (read access to Offers)." }, "response": [ { "header": [], "code": 200, "body": "{\n \"current_page\": 1,\n \"per_page\": 50,\n \"total\": 125,\n \"last_page\": 3,\n \"data\": [\n {\n \"name\": \"example.de\",\n \"type\": \"paynow\",\n \"status\": \"verified\",\n \"price\": 2999,\n \"template\": \"slim\",\n \"created_at\": \"2023-01-15T10:30:00.000000Z\",\n \"is_internal\": true,\n \"redirect_status\": true,\n \"hide_on_marketplace\": false,\n \"visitors\": {\n \"last_30_days\": 142,\n \"last_7_days\": 35,\n \"referrer_30_days\": 12\n },\n \"template_data\": {\n \"theme-color\": \"blue\",\n \"price-suggest\": \"true\"\n },\n \"tags\": [\"premium\", \"short\"],\n \"note\": \"Renew early, buyer interest from 2023.\"\n }\n ]\n}", "name": "Success" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated.\"\n}", "name": "Unauthenticated" } ] }, { "name": "List offer filter options", "request": { "url": { "host": "{{baseUrl}}", "path": "offers\/filters", "query": [], "raw": "{{baseUrl}}\/offers\/filters" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieve the tags and TLDs your sale pages can be filtered by via `GET \/offers`, along with how many sale pages currently match each option.\n\nRequires a token with the `offers:read` scope (read access to Offers)." }, "response": [ { "header": [], "code": 200, "body": "{\n \"tags\": [\n {\"name\": \"Premium\", \"slug\": \"premium\", \"count\": 8},\n {\"name\": \"Short\", \"slug\": \"short\", \"count\": 3}\n ],\n \"tlds\": [\n {\"tld\": \"de\", \"count\": 90},\n {\"tld\": \"com\", \"count\": 35}\n ]\n}", "name": "Success" } ] }, { "name": "Create a sale page", "request": { "url": { "host": "{{baseUrl}}", "path": "offers", "query": [], "raw": "{{baseUrl}}\/offers" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"example.de\",\"use_default_config\":false,\"template\":\"slim\",\"price\":2999,\"price_suggest\":true,\"qualified_leads\":false,\"theme_color\":\"blue\",\"hide_on_marketplace\":false,\"route_domain\":true,\"status\":\"activate\",\"display_name\":\"Example.de\",\"headline\":\"This domain is for sale\",\"text\":\"Contact us to make an offer.\"}" }, "description": "Create a sale page (domain offer) for a domain, identified by its domain name. Domains you manage with\nELITEDOMAINS become an internal sale page (`status: verified` right away); any other domain becomes an\nexternal sale page and stays `unverified` until its nameservers are pointed at ELITEDOMAINS, unless your\naccount is set up to skip that verification.\n\nFor an external domain, the sale page is saved before the DNS records that carry out its verification are\nset up; if a `500` is returned for an external domain, the sale page may already exist in a partially set\nup state. Retrying the request will then fail with `409` rather than completing the setup \u2014 check\n`GET \/offers` for the domain's status, or use `PATCH \/offers` to adjust its configuration, instead of\nretrying `POST \/offers`.\n\nRequires a token with the `offers:write` scope (write access to Offers)." }, "response": [ { "header": [], "code": 200, "body": "{\"message\": \"Sale page created\", \"name\": \"example.de\", \"status\": \"verified\", \"is_internal\": true}", "name": "Success" }, { "header": [], "code": 200, "body": "{\"message\": \"Sale page would be created (sandbox mode)\", \"name\": \"example.de\"}", "name": "Sandbox" }, { "header": [], "code": 400, "body": "{\"message\": \"Domain name is missing\"}", "name": "Missing domain name" }, { "header": [], "code": 400, "body": "{\"message\": \"Domain name is invalid\"}", "name": "Invalid domain" }, { "header": [], "code": 400, "body": "{\"message\": \"Template is required\"}", "name": "Missing template" }, { "header": [], "code": 400, "body": "{\"message\": \"Template must be one of: default, smart, expert, slim, sicherheit, vertrieb\"}", "name": "Invalid template" }, { "header": [], "code": 400, "body": "{\"message\": \"Price must be a whole number\"}", "name": "Invalid price" }, { "header": [], "code": 400, "body": "{\"message\": \"Price must be between 99 and 10000000\"}", "name": "Price out of range" }, { "header": [], "code": 400, "body": "{\"message\": \"Theme color must be one of: blue, green, yellow, orange, red, purple, gold, black\"}", "name": "Invalid theme color" }, { "header": [], "code": 400, "body": "{\"message\": \"Status must be one of: activate, deactivate\"}", "name": "Invalid status" }, { "header": [], "code": 400, "body": "{\"message\": \"Display name must match the domain name (only letter casing may differ)\"}", "name": "Invalid display name" }, { "header": [], "code": 400, "body": "{\"message\": \"Text is required when headline is provided\"}", "name": "Headline without text" }, { "header": [], "code": 400, "body": "{\"message\": \"Instant-buy templates require either a price or price_suggest to be enabled\"}", "name": "Instant-buy template without price" }, { "header": [], "code": 400, "body": "{\"message\": \"A payout bank account is required in your account settings before creating sale pages\"}", "name": "Missing payout account" }, { "header": [], "code": 400, "body": "{\"message\": \"This TLD is not supported\"}", "name": "Unsupported TLD" }, { "header": [], "code": 400, "body": "{\"message\": \"Invalid configuration\", \"fields\": [\"theme_color\"]}", "name": "Invalid configuration" }, { "header": [], "code": 409, "body": "{\"message\": \"Sale page already exists\"}", "name": "Sale page already exists" } ] }, { "name": "Update a sale page", "request": { "url": { "host": "{{baseUrl}}", "path": "offers", "query": [], "raw": "{{baseUrl}}\/offers" }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"example.de\",\"template\":\"slim\",\"price\":2999,\"price_suggest\":true,\"qualified_leads\":false,\"theme_color\":\"blue\",\"hide_on_marketplace\":false,\"route_domain\":true,\"status\":\"activate\",\"display_name\":\"Example.de\",\"headline\":\"This domain is for sale\",\"text\":\"Contact us to make an offer.\"}" }, "description": "Update the configuration of a sale page (domain offer), identified by its domain name. Only the fields provided in the request are changed; any field left out keeps its current value. Setting `status` to `deactivate` also stops the domain from routing to the sale page, if it was.\n\nRequires a token with the `offers:write` scope (write access to Offers)." }, "response": [ { "header": [], "code": 200, "body": "{\"message\": \"Sale page updated\", \"name\": \"example.de\"}", "name": "Success" }, { "header": [], "code": 200, "body": "{\"message\": \"Sale page would be updated (sandbox mode)\", \"name\": \"example.de\"}", "name": "Sandbox" }, { "header": [], "code": 400, "body": "{\"message\": \"Domain name is missing\"}", "name": "Missing domain name" }, { "header": [], "code": 400, "body": "{\"message\": \"Domain name is invalid\"}", "name": "Invalid domain" }, { "header": [], "code": 400, "body": "{\"message\": \"No changes provided\"}", "name": "No fields provided" }, { "header": [], "code": 400, "body": "{\"message\": \"Price must be a whole number\"}", "name": "Invalid price" }, { "header": [], "code": 400, "body": "{\"message\": \"Price must be between 99 and 10000000\"}", "name": "Price out of range" }, { "header": [], "code": 400, "body": "{\"message\": \"Template must be one of: default, smart, expert, slim, sicherheit, vertrieb\"}", "name": "Invalid template" }, { "header": [], "code": 400, "body": "{\"message\": \"Theme color must be one of: blue, green, yellow, orange, red, purple, gold, black\"}", "name": "Invalid theme color" }, { "header": [], "code": 400, "body": "{\"message\": \"Status must be one of: activate, deactivate\"}", "name": "Invalid status" }, { "header": [], "code": 400, "body": "{\"message\": \"Display name must match the domain name (only letter casing may differ)\"}", "name": "Invalid display name" }, { "header": [], "code": 400, "body": "{\"message\": \"Text is required when headline is provided\"}", "name": "Headline without text" }, { "header": [], "code": 400, "body": "{\"message\": \"Instant-buy templates require either a price or price_suggest to be enabled\"}", "name": "Instant-buy template without price" }, { "header": [], "code": 400, "body": "{\"message\": \"Invalid configuration\", \"fields\": [\"theme_color\"]}", "name": "Invalid configuration" }, { "header": [], "code": 404, "body": "{\"message\": \"Sale page not found\"}", "name": "Sale page not found" } ] }, { "name": "Update the price of a sale page", "request": { "url": { "host": "{{baseUrl}}", "path": "offers\/price", "query": [], "raw": "{{baseUrl}}\/offers\/price" }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"example.de\",\"price\":2999}" }, "description": "Update the asking price of a sale page (domain offer), identified by its domain name.\n\nRequires a token with the `offers:write` scope (write access to Offers)." }, "response": [ { "header": [], "code": 200, "body": "{\"message\": \"Sale price updated\", \"name\": \"example.de\", \"price\": 2999}", "name": "Success" }, { "header": [], "code": 200, "body": "{\"message\": \"Sale price would be updated (sandbox mode)\", \"name\": \"example.de\", \"price\": 2999}", "name": "Sandbox" }, { "header": [], "code": 400, "body": "{\"message\": \"Domain name is missing\"}", "name": "Missing domain name" }, { "header": [], "code": 400, "body": "{\"message\": \"Domain name is invalid\"}", "name": "Invalid domain" }, { "header": [], "code": 400, "body": "{\"message\": \"Price is missing\"}", "name": "Missing price" }, { "header": [], "code": 400, "body": "{\"message\": \"Price must be a whole number\"}", "name": "Invalid price" }, { "header": [], "code": 400, "body": "{\"message\": \"Price must be between 99 and 10000000\"}", "name": "Price out of range" }, { "header": [], "code": 404, "body": "{\"message\": \"Sale page not found\"}", "name": "Sale page not found" } ] }, { "name": "Delete a sale page", "request": { "url": { "host": "{{baseUrl}}", "path": "offers", "query": [], "raw": "{{baseUrl}}\/offers" }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"example.de\"}" }, "description": "Delete a sale page (domain offer), identified by its domain name. This only removes the sale page; the domain itself is not affected.\n\nRequires a token with the `offers:write` scope (write access to Offers)." }, "response": [ { "header": [], "code": 200, "body": "{\"message\": \"Sale page deleted\", \"name\": \"example.de\"}", "name": "Success" }, { "header": [], "code": 200, "body": "{\"message\": \"Sale page would be deleted (sandbox mode)\", \"name\": \"example.de\"}", "name": "Sandbox" }, { "header": [], "code": 400, "body": "{\"message\": \"Domain name is missing\"}", "name": "Missing domain name" }, { "header": [], "code": 400, "body": "{\"message\": \"Domain name is invalid\"}", "name": "Invalid domain" }, { "header": [], "code": 404, "body": "{\"message\": \"Sale page not found\"}", "name": "Sale page not found" } ] } ] }, { "name": "Handle Management", "description": "", "item": [ { "name": "List all handles", "request": { "url": { "host": "{{baseUrl}}", "path": "handles", "query": [ { "key": "page", "value": "1", "description": "The page number for pagination.", "disabled": false }, { "key": "per_page", "value": "500", "description": "Number of results per page. Default: 500, Max: 500.", "disabled": false } ], "raw": "{{baseUrl}}\/handles?page=1&per_page=500" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieve a paginated list of all contact handles in your account.\n\nRequires a token with the `handles:read` scope (read access to Handles)." }, "response": [ { "header": [], "code": 200, "body": "{\n \"current_page\": 1,\n \"per_page\": 500,\n \"data\": [\n {\n \"id\": 123,\n \"alias\": \"JohnPrivate\",\n \"type\": \"PERSON\",\n \"handle_name\": \"John Doe\",\n \"contact_person\": null,\n \"street_name\": \"Unter den Linden\",\n \"street_number\": \"12\",\n \"address_addition\": null,\n \"postalcode\": \"12345\",\n \"city\": \"Berlin\",\n \"state\": null,\n \"country_id\": 276,\n \"country_iso\": \"DE\",\n \"email\": \"john@example.com\",\n \"phone\": \"+49.16094751251\",\n \"created_at\": \"2023-01-15T10:30:00.000000Z\"\n }\n ]\n}", "name": "Success" } ] }, { "name": "Create a new handle", "request": { "url": { "host": "{{baseUrl}}", "path": "handles", "query": [], "raw": "{{baseUrl}}\/handles" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"alias\":\"JohnPrivate\",\"type\":\"PERSON\",\"handle_name\":\"John Doe\",\"contact_person\":\"John Doe\",\"street_name\":\"Unter den Linden\",\"street_number\":\"12\",\"address_addition\":\"3rd floor\",\"postalcode\":\"12345\",\"city\":\"Berlin\",\"state\":\"Berlin\",\"country_iso\":\"DE\",\"country_id\":276,\"email\":\"john@example.com\",\"phone\":\"+49.16094751251\",\"general_request\":\"general@example.com\",\"abuse_contact\":\"abuse@example.com\"}" }, "description": "Add a new contact handle to your account. Handles are used for domain contact information at the registry.\n\nThis endpoint may execute registry operations and counts against your API rate limit.\n\nRequires a token with the `handles:write` scope (write access to Handles)." }, "response": [ { "header": [], "code": 200, "body": "{\n \"id\": 123,\n \"alias\": \"JohnPrivate\",\n \"type\": \"PERSON\",\n \"handle_name\": \"John Doe\",\n \"contact_person\": null,\n \"street_name\": \"Unter den Linden\",\n \"street_number\": \"12\",\n \"address_addition\": null,\n \"postalcode\": \"12345\",\n \"city\": \"Berlin\",\n \"state\": null,\n \"country_id\": 276,\n \"country_iso\": \"DE\",\n \"email\": \"john@example.com\",\n \"phone\": \"+49.16094751251\",\n \"created_at\": \"2023-01-15T10:30:00.000000Z\"\n}", "name": "Success" }, { "header": [], "code": 400, "body": "{\n \"message\": \"Your input is invalid or incomplete.\",\n \"error\": {\"field\": [\"error message\"]}\n}", "name": "Validation error" }, { "header": [], "code": 500, "body": "{\"message\": \"Unknown error\"}", "name": "Unknown error" } ] }, { "name": "Update a handle", "request": { "url": { "host": "{{baseUrl}}", "path": "handles\/:id", "query": [], "raw": "{{baseUrl}}\/handles\/:id", "variable": [ { "id": "id", "key": "id", "value": 123, "description": "The handle ID." } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"alias\":\"JohnPrivate\",\"contact_person\":\"John Doe\",\"street_name\":\"Unter den Linden\",\"street_number\":\"12\",\"address_addition\":\"3rd floor\",\"postalcode\":\"12345\",\"city\":\"Berlin\",\"state\":\"Berlin\",\"country_iso\":\"DE\",\"country_id\":276,\"email\":\"john@example.com\",\"phone\":\"+49.16094751251\",\"general_request\":\"general@example.com\",\"abuse_contact\":\"abuse@example.com\"}" }, "description": "Update an existing contact handle. Only include fields you want to update.\n\nThis endpoint may execute registry operations and counts against your API rate limit.\n\nRequires a token with the `handles:write` scope (write access to Handles)." }, "response": [ { "header": [], "code": 200, "body": "{\n \"id\": 123,\n \"alias\": \"JohnPrivate\",\n \"type\": \"PERSON\",\n \"handle_name\": \"John Doe\",\n \"contact_person\": null,\n \"street_name\": \"Unter den Linden\",\n \"street_number\": \"12\",\n \"address_addition\": null,\n \"postalcode\": \"12345\",\n \"city\": \"Berlin\",\n \"state\": null,\n \"country_id\": 276,\n \"country_iso\": \"DE\",\n \"email\": \"john@example.com\",\n \"phone\": \"+49.16094751251\",\n \"created_at\": \"2023-01-15T10:30:00.000000Z\"\n}", "name": "Success" }, { "header": [], "code": 400, "body": "{\n \"message\": \"Your input is invalid or incomplete.\",\n \"error\": {\"field\": [\"error message\"]}\n}", "name": "Validation error" }, { "header": [], "code": 404, "body": "{\"message\": \"Handle not found\"}", "name": "Handle not found" } ] } ] }, { "name": "Invoices", "description": "", "item": [ { "name": "List invoices", "request": { "url": { "host": "{{baseUrl}}", "path": "invoices", "query": [ { "key": "page", "value": "1", "description": "The page number for pagination.", "disabled": false }, { "key": "per_page", "value": "50", "description": "Number of results per page. Default: 50, Max: 500.", "disabled": false }, { "key": "status", "value": "complete", "description": "Filter by status. Accepts a comma-separated list of statuses (`draft`, `pending`, `complete`, `failed`, `dispute`, `incomplete`, `inkasso`, `lost`, `cancelled`).", "disabled": false }, { "key": "from", "value": "2026-01-01", "description": "Only invoices created on or after this date (`YYYY-MM-DD`).", "disabled": false }, { "key": "to", "value": "2026-06-30", "description": "Only invoices created on or before this date (`YYYY-MM-DD`).", "disabled": false }, { "key": "order_direction", "value": "desc", "description": "Sort direction by invoice date. Default: `desc` (newest first). Options: `asc`, `desc`.", "disabled": false } ], "raw": "{{baseUrl}}\/invoices?page=1&per_page=50&status=complete&from=2026-01-01&to=2026-06-30&order_direction=desc" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"from\":\"2026-08-13T12:08:40\",\"to\":\"2026-08-13T12:08:40\"}" }, "description": "Retrieve a paginated list of your invoices, most recent first. Amounts are in EUR.\n\nRequires a token with the `invoices:read` scope (read access to Invoices)." }, "response": [ { "header": [], "code": 200, "body": "{\n \"current_page\": 1,\n \"per_page\": 50,\n \"total\": 1,\n \"last_page\": 1,\n \"data\": [\n {\n \"id\": 123,\n \"number\": \"R202600123\",\n \"date\": \"2026-03-01T04:30:00.000000Z\",\n \"status\": \"complete\",\n \"payment_method\": \"card\",\n \"instant_payment\": true,\n \"amounts\": {\n \"net_amount\": 100.0,\n \"tax_percentage\": 19.0,\n \"tax_amount\": 19.0,\n \"gross_amount\": 119.0,\n \"warning_fee_amount\": 0.0,\n \"total_amount\": 119.0,\n \"paid_amount\": 119.0,\n \"open_amount\": 0.0\n },\n \"discounts\": []\n }\n ]\n}", "name": "Success" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated.\"\n}", "name": "Unauthenticated" } ] }, { "name": "Get an invoice", "request": { "url": { "host": "{{baseUrl}}", "path": "invoices\/:id", "query": [], "raw": "{{baseUrl}}\/invoices\/:id", "variable": [ { "id": "id", "key": "id", "value": 123, "description": "The invoice ID, as returned by `GET \/invoices`." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieve a single invoice including its line items (positions), as printed on the invoice document. Amounts are in EUR.\n\nRequires a token with the `invoices:read` scope (read access to Invoices)." }, "response": [ { "header": [], "code": 200, "body": "{\n \"id\": 123,\n \"number\": \"R202600123\",\n \"date\": \"2026-03-01T04:30:00.000000Z\",\n \"status\": \"complete\",\n \"payment_method\": \"card\",\n \"instant_payment\": true,\n \"amounts\": {\n \"net_amount\": 100.0,\n \"tax_percentage\": 19.0,\n \"tax_amount\": 19.0,\n \"gross_amount\": 119.0,\n \"warning_fee_amount\": 0.0,\n \"total_amount\": 119.0,\n \"paid_amount\": 119.0,\n \"open_amount\": 0.0\n },\n \"discounts\": [],\n \"positions\": [\n {\n \"label\": \"Verl\u00e4ngerung .de, 1 Jahr\",\n \"count\": 20,\n \"single_price\": 5.0,\n \"total\": 100.0\n }\n ]\n}", "name": "Success" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated.\"\n}", "name": "Unauthenticated" }, { "header": [], "code": 404, "body": "{\n \"message\": \"Invoice not found\"\n}", "name": "Not found" } ] }, { "name": "List an invoice's service records", "request": { "url": { "host": "{{baseUrl}}", "path": "invoices\/:id\/services", "query": [], "raw": "{{baseUrl}}\/invoices\/:id\/services", "variable": [ { "id": "id", "key": "id", "value": 123, "description": "The invoice ID, as returned by `GET \/invoices`." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieve the service records (Leistungsabrechnung) of an invoice: one record per billed domain or service, mirroring the invoice's service record document\/CSV. Type and period values match the document (German). Prices are net, in EUR.\n\nRequires a token with the `invoices:read` scope (read access to Invoices)." }, "response": [ { "header": [], "code": 200, "body": "{\n \"invoice\": {\n \"id\": 123,\n \"number\": \"R202600123\"\n },\n \"data\": [\n {\n \"name\": \"example.de\",\n \"type\": \"Verl\u00e4ngerung\",\n \"period\": \"01.06.2026 - 30.06.2026\",\n \"price\": 5.0\n }\n ]\n}", "name": "Success" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated.\"\n}", "name": "Unauthenticated" }, { "header": [], "code": 404, "body": "{\n \"message\": \"Invoice not found\"\n}", "name": "Not found" } ] } ] }, { "name": "Journal", "description": "", "item": [ { "name": "List the journal", "request": { "url": { "host": "{{baseUrl}}", "path": "journal", "query": [ { "key": "page", "value": "1", "description": "The page number for pagination.", "disabled": false }, { "key": "per_page", "value": "50", "description": "Number of results per page. Default: 50, Max: 500.", "disabled": false }, { "key": "domain", "value": "example.de", "description": "Filter by domain name (matches domains containing this value).", "disabled": false }, { "key": "type", "value": "domain-renewed,domain-transfer", "description": "Filter by type of change. Comma-separated for multiple values.", "disabled": false }, { "key": "source", "value": "interface", "description": "Filter by where the change originated. Comma-separated for multiple values. Options: `interface`, `api`, `mcp`, `customer_service`, `system`, `paynow`.", "disabled": false } ], "raw": "{{baseUrl}}\/journal?page=1&per_page=50&domain=example.de&type=domain-renewed%2Cdomain-transfer&source=interface" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieve a paginated list of journal entries recording changes made to your domains (registrations, transfers, renewals, handle\/redirector changes, deletions, ...), most recent first.\n\nRequires a token with the `journal:read` scope (read access to Journal)." }, "response": [ { "header": [], "code": 200, "body": "{\n \"current_page\": 1,\n \"per_page\": 50,\n \"total\": 1,\n \"last_page\": 1,\n \"data\": [\n {\n \"date\": \"2024-03-10T14:30:00.000000Z\",\n \"domain\": \"example.de\",\n \"type\": \"domain-renewed\",\n \"message\": \"Laufzeit verl\u00e4ngert\",\n \"source\": \"interface\"\n }\n ]\n}", "name": "Success" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated.\"\n}", "name": "Unauthenticated" } ] } ] }, { "name": "Leads", "description": "", "item": [ { "name": "List all leads", "request": { "url": { "host": "{{baseUrl}}", "path": "leads", "query": [ { "key": "page", "value": "1", "description": "The page number for pagination.", "disabled": false }, { "key": "per_page", "value": "50", "description": "Number of results per page. Default: 50, Max: 500.", "disabled": false }, { "key": "domain", "value": "example.de", "description": "Filter by domain name (matches domains containing this value).", "disabled": false }, { "key": "order_by", "value": "last_interaction_at", "description": "Field to order by. Default: `last_interaction_at`. Options: `last_interaction_at`, `first_contact_at`, `domain`, `current_price`.", "disabled": false }, { "key": "order_direction", "value": "desc", "description": "Order direction. Default: `desc`. Options: `asc`, `desc`.", "disabled": false } ], "raw": "{{baseUrl}}\/leads?page=1&per_page=50&domain=example.de&order_by=last_interaction_at&order_direction=desc" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieve a paginated list of leads (interested buyers) across all your sale pages: buyer price suggestions, contact requests and abandoned checkouts that turned into a negotiation. Draft and in-progress checkout entries that have not become an actual lead yet are not included.\n\nRequires a token with the `leads:read` scope (read access to Leads)." }, "response": [ { "header": [], "code": 200, "body": "{\n \"current_page\": 1,\n \"per_page\": 50,\n \"total\": 1,\n \"last_page\": 1,\n \"data\": [\n {\n \"id\": 123,\n \"domain\": \"example.de\",\n \"source\": \"buyer_price_suggestion\",\n \"original_price\": 2999,\n \"current_price\": 2500,\n \"first_contact_at\": \"2024-03-08T09:15:00.000000Z\",\n \"last_interaction_at\": \"2024-03-10T14:30:00.000000Z\",\n \"note\": \"Renew early, buyer interest from 2023.\",\n \"metadata\": {\n \"timezone\": \"Europe\/Berlin\",\n \"city\": \"Berlin\",\n \"country\": \"Germany\",\n \"device_type\": \"Desktop\"\n },\n \"interactions\": [\n {\n \"type\": \"buyer_price_suggestion\",\n \"price\": 2500,\n \"content\": null,\n \"created_at\": \"2024-03-08T09:15:00.000000Z\"\n },\n {\n \"type\": \"seller_price_accepted\",\n \"price\": 2500,\n \"content\": null,\n \"created_at\": \"2024-03-10T14:30:00.000000Z\"\n }\n ]\n }\n ]\n}", "name": "Success" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated.\"\n}", "name": "Unauthenticated" } ] }, { "name": "Send a counter-offer", "request": { "url": { "host": "{{baseUrl}}", "path": "leads\/:id\/counter-offer", "query": [], "raw": "{{baseUrl}}\/leads\/:id\/counter-offer", "variable": [ { "id": "id", "key": "id", "value": 123, "description": "The lead ID, as returned by `GET \/leads`." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"price\":2500}" }, "description": "Set a new asking price for a lead, identified by its lead ID from `GET \/leads`. Use this both to send the seller's first price to a lead that only made contact (no price on the table yet), and to counter a buyer's pending price suggestion. The buyer receives an email with the new price and a checkout link, valid for 72 hours.\n\nRequires a token with the `leads:write` scope (write access to Leads)." }, "response": [ { "header": [], "code": 200, "body": "{\"message\": \"Counter-offer sent\", \"id\": 123, \"price\": 2500}", "name": "Success" }, { "header": [], "code": 200, "body": "{\"message\": \"Counter-offer would be sent (sandbox mode)\", \"id\": 123, \"price\": 2500}", "name": "Sandbox" }, { "header": [], "code": 400, "body": "{\"message\": \"Price is missing\"}", "name": "Missing price" }, { "header": [], "code": 400, "body": "{\"message\": \"Price must be a whole number\"}", "name": "Invalid price" }, { "header": [], "code": 400, "body": "{\"message\": \"Price must be between 99 and 10000000\"}", "name": "Price out of range" }, { "header": [], "code": 400, "body": "{\"message\": \"This lead has no buyer email on file\"}", "name": "No buyer email on file" }, { "header": [], "code": 404, "body": "{\"message\": \"Lead not found\"}", "name": "Lead not found" } ] }, { "name": "Accept a price suggestion", "request": { "url": { "host": "{{baseUrl}}", "path": "leads\/:id\/accept", "query": [], "raw": "{{baseUrl}}\/leads\/:id\/accept", "variable": [ { "id": "id", "key": "id", "value": 123, "description": "The lead ID, as returned by `GET \/leads`." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Accept a lead's pending buyer price suggestion, identified by its lead ID from `GET \/leads`. The buyer receives an email confirming their price and a checkout link to complete the purchase, valid for 72 hours.\n\nRequires a token with the `leads:write` scope (write access to Leads)." }, "response": [ { "header": [], "code": 200, "body": "{\"message\": \"Price suggestion accepted\", \"id\": 123, \"price\": 2500}", "name": "Success" }, { "header": [], "code": 200, "body": "{\"message\": \"Price suggestion would be accepted (sandbox mode)\", \"id\": 123, \"price\": 2500}", "name": "Sandbox" }, { "header": [], "code": 400, "body": "{\"message\": \"This lead has no pending price suggestion to accept\"}", "name": "No pending suggestion" }, { "header": [], "code": 400, "body": "{\"message\": \"This lead has no buyer email on file\"}", "name": "No buyer email on file" }, { "header": [], "code": 404, "body": "{\"message\": \"Lead not found\"}", "name": "Lead not found" } ] } ] }, { "name": "Notes", "description": "", "item": [ { "name": "List all notes", "request": { "url": { "host": "{{baseUrl}}", "path": "notes", "query": [ { "key": "page", "value": "1", "description": "The page number for pagination.", "disabled": false }, { "key": "per_page", "value": "50", "description": "Number of results per page. Default: 50, Max: 100.", "disabled": false }, { "key": "domain", "value": "example.de", "description": "Filter by domain name (matches domains containing this value).", "disabled": false }, { "key": "order_by", "value": "updated_at", "description": "Field to sort by. Default: `updated_at`. Options: `updated_at`, `created_at`, `domain`.", "disabled": false }, { "key": "order_direction", "value": "desc", "description": "Sort direction. Default: `desc`. Options: `asc`, `desc`.", "disabled": false } ], "raw": "{{baseUrl}}\/notes?page=1&per_page=50&domain=example.de&order_by=updated_at&order_direction=desc" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieve a paginated list of your domain notes. A note belongs to a domain name rather than to a single resource, so the same note is also returned inline on that domain in `GET \/domains`, `GET \/offers`, `GET \/leads`, `GET \/transactions` and `GET \/catcher`. Use this endpoint to read notes on domains that have no listing of their own, such as SEDO domains.\n\nRequires a token with the `notes:read` scope (read access to Notes)." }, "response": [ { "header": [], "code": 200, "body": "{\n \"current_page\": 1,\n \"per_page\": 50,\n \"total\": 1,\n \"last_page\": 1,\n \"data\": [\n {\n \"domain\": \"example.de\",\n \"content\": \"Renew early, buyer interest from 2023.\",\n \"created_at\": \"2024-03-08T09:15:00.000000Z\",\n \"updated_at\": \"2024-03-10T14:30:00.000000Z\"\n }\n ]\n}", "name": "Success" }, { "header": [], "code": 400, "body": "{\"message\": \"Domain filter is invalid\"}", "name": "Invalid filter" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated.\"\n}", "name": "Unauthenticated" } ] }, { "name": "Create or update a note", "request": { "url": { "host": "{{baseUrl}}", "path": "notes", "query": [], "raw": "{{baseUrl}}\/notes" }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"example.de\",\"content\":\"Renew early, buyer interest from 2023.\"}" }, "description": "Write your note for a domain, replacing any note you had on it. Notes are private to your account and are attached to the domain name itself, so the note written here also shows up on that domain's sale page, leads, transactions, catcher order and SEDO entry. Sending an empty or `null` `content` deletes the note, exactly like `DELETE \/notes`.\n\nRequires a token with the `notes:write` scope (write access to Notes)." }, "response": [ { "header": [], "code": 200, "body": "{\"message\": \"Note saved\", \"name\": \"example.de\"}", "name": "Success" }, { "header": [], "code": 200, "body": "{\"message\": \"Note deleted\", \"name\": \"example.de\"}", "name": "Note deleted" }, { "header": [], "code": 200, "body": "{\"message\": \"Note would be saved (sandbox mode)\", \"name\": \"example.de\"}", "name": "Sandbox" }, { "header": [], "code": 200, "body": "{\"message\": \"Note would be deleted (sandbox mode)\", \"name\": \"example.de\"}", "name": "Sandbox delete" }, { "header": [], "code": 400, "body": "{\"message\": \"Domain name is missing\"}", "name": "Missing domain name" }, { "header": [], "code": 400, "body": "{\"message\": \"Domain name is invalid\"}", "name": "Invalid domain" }, { "header": [], "code": 400, "body": "{\"message\": \"Content is missing\"}", "name": "Missing content" }, { "header": [], "code": 400, "body": "{\"message\": \"Content is invalid\"}", "name": "Invalid content" }, { "header": [], "code": 400, "body": "{\"message\": \"Content must not be longer than 10000 characters\"}", "name": "Content too long" } ] }, { "name": "Delete a note", "request": { "url": { "host": "{{baseUrl}}", "path": "notes", "query": [], "raw": "{{baseUrl}}\/notes" }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"example.de\"}" }, "description": "Remove your note from a domain. The domain itself and everything attached to it are not affected.\n\nRequires a token with the `notes:write` scope (write access to Notes)." }, "response": [ { "header": [], "code": 200, "body": "{\"message\": \"Note deleted\", \"name\": \"example.de\"}", "name": "Success" }, { "header": [], "code": 200, "body": "{\"message\": \"Note would be deleted (sandbox mode)\", \"name\": \"example.de\"}", "name": "Sandbox" }, { "header": [], "code": 400, "body": "{\"message\": \"Domain name is missing\"}", "name": "Missing domain name" }, { "header": [], "code": 400, "body": "{\"message\": \"Domain name is invalid\"}", "name": "Invalid domain" }, { "header": [], "code": 404, "body": "{\"message\": \"Note not found\"}", "name": "Note not found" } ] } ] }, { "name": "Transactions", "description": "", "item": [ { "name": "List transactions", "request": { "url": { "host": "{{baseUrl}}", "path": "transactions", "query": [ { "key": "page", "value": "1", "description": "The page number for pagination.", "disabled": false }, { "key": "per_page", "value": "50", "description": "Number of results per page. Default: 50, Max: 500.", "disabled": false }, { "key": "domain", "value": "example.de", "description": "Filter by domain name (matches domains containing this value).", "disabled": false }, { "key": "order_by", "value": "purchase_date", "description": "Field to sort by. Default: `purchase_date`. Options: `purchase_date`, `completion_date`, `domain`, `net_price`, `gross_price`, `payout_amount`.", "disabled": false }, { "key": "order_direction", "value": "desc", "description": "Sort direction. Default: `desc`. Options: `asc`, `desc`.", "disabled": false } ], "raw": "{{baseUrl}}\/transactions?page=1&per_page=50&domain=example.de&order_by=purchase_date&order_direction=desc" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieve a paginated list of your domain sale transactions (purchases made by buyers through Paynow), most recent first. Buyer personal data is never included.\n\nRequires a token with the `transactions:read` scope (read access to Transactions)." }, "response": [ { "header": [], "code": 200, "body": "{\n \"current_page\": 1,\n \"per_page\": 50,\n \"total\": 1,\n \"last_page\": 1,\n \"data\": [\n {\n \"id\": 123,\n \"domain\": \"example.de\",\n \"status\": {\n \"payment\": \"success\",\n \"transfer\": \"transferred\",\n \"payout\": \"done\"\n },\n \"price\": {\n \"net_price\": 1000.0,\n \"gross_price\": 1190.0,\n \"tax_percentage\": 19.0,\n \"tax_amount\": 190.0,\n \"fee_percentage\": 8.0,\n \"fee_amount\": 80.0,\n \"payout_amount\": 1110.0\n },\n \"payment_method\": \"paypal\",\n \"purchase_date\": \"2024-03-10T14:30:00.000000Z\",\n \"completion_date\": \"2024-03-15T09:00:00.000000Z\",\n \"documents\": {\n \"invoice\": \"https:\/\/app.elitedomains.de\/example.de\/invoice\/MTIz\/9b1f2c3a-...\",\n \"provision\": \"https:\/\/app.elitedomains.de\/example.de\/provision\/MTIz\/9b1f2c3a-...\"\n },\n \"note\": \"Renew early, buyer interest from 2023.\"\n }\n ]\n}", "name": "Success" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated.\"\n}", "name": "Unauthenticated" } ] } ] } ], "auth": { "type": "bearer", "bearer": [ { "key": "Authorization", "type": "string" } ] } }