List custom fields

  2 minute read  

GET https://www.digicert.com/services/v2/account/metadata
Use this endpoint to list metadata for custom order fields in your account.

Example requests and responses

curl -X GET \
  https://www.digicert.com/services/v2/account/metadata \
  -H 'Content-Type: application/json' \
  -H 'X-DC-DEVKEY: {{api_key}}'
import requests

url = "https://www.digicert.com/services/v2/account/metadata"

payload = ""
headers = {
    'X-DC-DEVKEY': "{{api_key}}",
    'Content-Type': "application/json"
    }

response = requests.request("GET", url, data=payload, headers=headers)

print(response.text)
package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://www.digicert.com/services/v2/account/metadata"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-DC-DEVKEY", "{{api_key}}")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
var request = require("request");

var options = { method: 'GET',
  url: 'https://www.digicert.com/services/v2/account/metadata',
  headers: 
   { 'Content-Type': 'application/json',
     'X-DC-DEVKEY': '{{api_key}}' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
{
  "metadata": [
    {
      "id": 112,
      "label": "Additional emails",
      "is_required": false,
      "is_active": true,
      "data_type": "email_list"
    },
    {
      "id": 113,
      "label": "Jira URL",
      "is_required": false,
      "is_active": true,
    },
    {
      "id": 114,
      "label": "For department",
      "is_required": true,
      "is_active": true,
      "data_type": "text"
    },
    {
      "id": 115,
      "label": "Invoice #",
      "is_required": true,
      "is_active": true,
      "data_type": "int"
    },
    {
      "id": 116,
      "label": "SRE contact",
      "is_required": false,
      "is_active": false,
      "data_type": "email_address"
    }
  ]
}
// If there are no custom fields, the call returns an empty JSON object.

{}

Response parameters

NameTypeDescription
metadataarrayList of returned custom order field objects. Only returned for accounts with custom order fields. If there are no custom order fields, the call returns an empty JSON object.
.. idintCustom order field ID.
.. labelstringName of the custom order field. When you use the CertCenral console to request a certificate, this name appears above the custom field on the certificate order form.
.. is_requiredboolSpecifies if the field is required.
.. is_activeboolSpecifies if the field appears on the order form.
.. data_typestringInput type for the customer order field. If missing, this indicates an input type of anything.SeeGlossary – Custom order field input types
.. show_in_receiptboolIf true, DigiCert displays the custom field on order receipts. Otherwise, false (default).