Sign in
Tld

Show TLD

Show a TLD

get/2/tld/{tld}

Path parameters

tldstring required

Query parameters

withstring

Optional : Allows loading additional data about a resource, which may include related resources.

Response

OK

result'success' | 'error' | 'asynchronous' required

Result of the HTTP request

Example response

{
  "result": "success",
  "data": {
    "id": 12345,
    "tld": "ch",
    "groups": [
      {
        "id": 12345,
        "name": "environment"
      }
    ],
    "fields": {
      "contacts": [
        {
          "type": "text",
          "name": "owner",
          "restricted_fields": [
            {
              "type": "text",
              "name": "company_number",
              "description": "Company registration number",
              "guideline": "Please enter a valid company number",
              "min_length": 5,
              "max_length": 20,
              "pattern": "^[A-Z0-9]+$",
              "note": "Format: ABC123456",
              "default": "lorem ipsum",
              "required_conditions": [
                {
                  "field": "company_type",
                  "operator": "equals",
                  "value": "corporation",
                  "contact": "owner",
                  "logic": "AND"
                }
              ]
            }
          ]
        }
      ],
      "registration": [
        {
          "type": "text",
          "name": "company_number",
          "description": "Company registration number",
          "guideline": "Please enter a valid company number",
          "min_length": 5,
          "max_length": 20,
          "pattern": "^[A-Z0-9]+$",
          "note": "Format: ABC123456",
          "default": "lorem ipsum",
          "required_conditions": [
            {
              "field": "company_type",
              "operator": "equals",
              "value": "corporation",
              "contact": "owner",
              "logic": "AND"
            }
          ]
        }
      ],
      "transfer": [
        {
          "type": "text",
          "name": "company_number",
          "description": "Company registration number",
          "guideline": "Please enter a valid company number",
          "min_length": 5,
          "max_length": 20,
          "pattern": "^[A-Z0-9]+$",
          "note": "Format: ABC123456",
          "default": "lorem ipsum",
          "required_conditions": [
            {
              "field": "company_type",
              "operator": "equals",
              "value": "corporation",
              "contact": "owner",
              "logic": "AND"
            }
          ]
        }
      ]
    }
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.