List custom fields


Use this endpoint to list metadata for custom order fields in your account.

curl -X GET \ \
  -H 'Content-Type: application/json' \
  -H 'X-DC-DEVKEY: {{api_key}}'
import requests

url = ""

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

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

package main

import (

func main() {

	url := ""

	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)


var request = require("request");

var options = { method: 'GET',
  url: '',
   { 'Content-Type': 'application/json',
     'X-DC-DEVKEY': '{{api_key}}' } };

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

200 OK
  "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"
200 OK No custom fields
// If there are no custom fields, the call returns an empty JSON object.


Response parameters

Name Type Description
metadata array List 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.
.. id int Custom order field ID.
.. label string Name of the custom order field.
This name appears above the field on the order form.
.. is_required bool Specifies if the field is required.
.. is_active bool Specifies if the field appears on the order form.
.. data_type string Input type for the customer order field.
If missing, this indicates an input type of anything.
See Glossary – Custom order field input types