v4

latestOpenAPI 3.1.02026-08-031873791.4 MB

Custom Fields

List custom fields

Retrieve a paginated list of custom field definitions with filtering and ordering options.

get/public/v1/custom-fields/

Query parameters

searchstring nullable

idinteger[] nullable

field_type'text' | 'number' | 'currency' | 'date' | 'boolean' | 'single_select' | 'multi_select' | 'link' | 'paragraph' nullable

is_activeboolean nullable

namestring nullable

record_type'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'

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

company_idinteger nullable

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

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

is_requiredboolean nullable

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

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

is_active_recordboolean nullable

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

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

orderingstring nullable

limitinteger

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

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

offsetinteger

Number of records to skip before starting to return results

Number of records to skip before starting to return results

Response

OK

countinteger required