List all Custom Field definitions

GET/api/custom-fields

Headers

FieldTypeDescription
authtoken String Authentication token, generated from admin area

Parameters

FieldTypeDescription
related_to String optional Optional context filter. One of: clients, client_contacts, companies, contracts, estimates, events, expenses, invoices, items, leads, lead_contacts, orders, projects, project_files, proposals, subscriptions, tasks, team_members, tickets, timesheets
curl -X GET "https://yoursite.com/api/custom-fields" \
  -H "authtoken: YOUR_API_TOKEN"

Success-Response:

HTTP/1.1 200 OK
[
  {
    "id": "3",
    "title": "Region",
    "title_language_key": "",
    "placeholder": "",
    "placeholder_language_key": "",
    "template_variable_name": "",
    "options": "North,South",
    "field_type": "select",
    "related_to": "clients",
    "sort": "1",
    "required": "0",
    "add_filter": "0",
    "show_in_table": "0",
    "show_in_invoice": "0",
    "show_in_estimate": "0",
    "show_in_contract": "0",
    "show_in_order": "0",
    "show_in_proposal": "0",
    "show_in_subscription": "0",
    "show_in_embedded_form": "0",
    "visible_to_admins_only": "0",
    "hide_from_clients": "0",
    "disable_editing_by_clients": "0",
    "show_on_kanban_card": "0",
    "deleted": "0"
  }
]

Error-Response:

HTTP/1.1 404 Not Found
{ "status": false, "messages": { "error": "No data were found" } }
MethodGET
Path/api/custom-fields
GroupCustom Fields
Sincev1.0.0
Defined inRestApi/Controllers/CustomFieldsController.php