List the contact schemas for a TLD

GET /v2/domain-tlds/{tld}/contact-schemas/

API version

v2

Request method

GET

Operation ID

domain-list-tld-contact-schemas

---

List the contact schemas describing the fields required to register/transfer a Domain.

Request

• tldstring

  required

  The top level domain to retrieve the schemas for.

  Example:{"value":"de"}

Responses

Format

application/json

Description

The JSON-Schema objects.

Schema documentation

• jsonSchemaAdminCobject
• jsonSchemaOwnerCobject

  required

Example

{
  "jsonSchemaAdminC": {},
  "jsonSchemaOwnerC": {}
}

JSON Schema

{
  "properties": {
    "jsonSchemaAdminC": {
      "type": "object"
    },
    "jsonSchemaOwnerC": {
      "type": "object"
    }
  },
  "required": [
    "jsonSchemaOwnerC"
  ],
  "type": "object"
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v2/domain-tlds/string/contact-schemas

JavaScript SDK

import { MittwaldAPIV2Client } from "@mittwald/api-client";
import { assertStatus } from "@mittwald/api-client-commons";
  
const client = MittwaldAPIClient.newWithToken(process.env.MITTWALD_API_TOKEN);
const response = await client.domain.listTldContactSchemas({
  "tld": "string"
});

assertStatus(response, 200);
  

PHP SDK

use \Mittwald\ApiClient\Generated\V2\Clients\Domain\ListTldContactSchemas\ListTldContactSchemasRequest;
  
$client = MittwaldAPIClient::newWithToken(getenv('MITTWALD_API_TOKEN'));

$request = (new ListTldContactSchemasRequest(
  tld: "string"
));
$response = $client->domain()->listTldContactSchemas($request);

var_dump($response->getBody();