List custom fields (v1) - DualEntry Documentation

GET

public

custom-fields

List custom fields

curl --request GET \
  --url https://api.dualentry.com/public/v1/custom-fields/ \
  --header 'X-API-KEY: <api-key>'

import requests

url = "https://api.dualentry.com/public/v1/custom-fields/"

headers = {"X-API-KEY": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};

fetch('https://api.dualentry.com/public/v1/custom-fields/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.dualentry.com/public/v1/custom-fields/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.dualentry.com/public/v1/custom-fields/"

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

	req.Header.Add("X-API-KEY", "<api-key>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.dualentry.com/public/v1/custom-fields/")
  .header("X-API-KEY", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.dualentry.com/public/v1/custom-fields/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "items": [
    {
      "id": 123,
      "name": "<string>",
      "is_active": true,
      "company_id": 123,
      "company_ids": [],
      "description": "<string>",
      "helper_text": "<string>",
      "applies_to": [],
      "default_value": "<string>",
      "options": [
        "<string>"
      ]
    }
  ],
  "count": 123
}

{
  "errors": {},
  "success": false
}

Authorizations

X-API-KEY

string

header

required

Query Parameters

string | null

integer[] | null

field_type

enum<string> | null

Available options:

text,

number,

currency,

date,

boolean,

single_select,

multi_select,

link,

paragraph

is_active

boolean | null

name

string | null

record_type

enum<string> | null

Filter to fields that apply to this record type (e.g. customer, invoice).

Available options:

invoice,

bill,

direct_expense,

journal_entry,

vendor_prepayment,

vendor_credit,

vendor_payment,

vendor_refund,

customer_payment,

customer_prepayment,

customer_refund,

customer_deposit,

currency_revaluation,

contract,

fixed_asset,

customer,

vendor,

company,

sales_order,

cash_sale,

customer_credit

company_id

integer | null

Include both org-level fields and fields scoped to this company id.

is_required

boolean | null

Filter on the is_required flag of the applies_to entry (needs record_type).

is_active_record

boolean | null

Filter on the is_active flag of the applies_to entry (needs record_type).

ordering

string | null

default:-updated_at

limit

integer

default:100

Number of records to return per page (capped at 100)

Required range: x >= 1

offset

integer

default:0

Number of records to skip before starting to return results

Required range: x >= 0

Response

items

PublicCustomFieldSchemaOut · object[]

required

Show child attributes

count

integer

required

Last modified on July 13, 2026

List Classification Lines (v1)

Create custom field (v1)

⌘I

List custom fields

curl --request GET \
  --url https://api.dualentry.com/public/v1/custom-fields/ \
  --header 'X-API-KEY: <api-key>'

import requests

url = "https://api.dualentry.com/public/v1/custom-fields/"

headers = {"X-API-KEY": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};

fetch('https://api.dualentry.com/public/v1/custom-fields/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.dualentry.com/public/v1/custom-fields/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.dualentry.com/public/v1/custom-fields/"

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

	req.Header.Add("X-API-KEY", "<api-key>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.dualentry.com/public/v1/custom-fields/")
  .header("X-API-KEY", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.dualentry.com/public/v1/custom-fields/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "items": [
    {
      "id": 123,
      "name": "<string>",
      "is_active": true,
      "company_id": 123,
      "company_ids": [],
      "description": "<string>",
      "helper_text": "<string>",
      "applies_to": [],
      "default_value": "<string>",
      "options": [
        "<string>"
      ]
    }
  ],
  "count": 123
}

{
  "errors": {},
  "success": false
}