Get Custom Fields

Get Custom Fields

GET

Retrieve all custom fields.

Request

GET /v1/custom-field

Query Parameters

Parameter	Type	Description
entity_name	string	Optional. Filter custom fields by entity. Allowed values: candidate, contact, organization, job, deal. If omitted, custom fields for all supported entities are returned.

Request Examples

Show all custom fields

GET /v1/custom-field

Show candidate custom fields

GET /v1/custom-field?entity_name=candidate

Show organization custom fields

GET /v1/custom-field?entity_name=organization

Response Fields

Field	Type	Description
id	integer	Custom field id used in custom_fields. This id is unique within the returned entity type.
field_name	string	Custom field label shown in ATZ CRM.
field_type	string	Custom field type, such as text, number, date, dropdown, or file.
default_value	string or null	Default value or option list for the field. Dropdown options may be returned as comma-separated values.
entity_name	string	Entity this custom field belongs to. Values include candidate, contact, organization, job, and deal.
dependency	object or null	Visibility rules when this field is controlled by another custom field. Returns null for independent fields and root parent fields.
dependency.parent_field_id	integer	Parent custom field id. This uses the same public id value returned by this endpoint and accepted in custom_fields.
dependency.parent_field_name	string	Parent custom field label.
dependency.parent_field_type	string	Parent custom field type. Nested custom-field parents can be checkbox, dropdown, or multiselect.
dependency.visible_when	array	Conditions that make this field visible. Each item represents one parent value that activates the child field.
dependency.visible_when[].parent_value	string or boolean	Parent value that makes this child field visible. Dropdown and multiselect parents return option values as strings. Checkbox parents return true or false.
dependency.visible_when[].allowed_child_options	array or null	For dropdown and multiselect child fields, this contains the allowed child option values when the parent condition restricts the child options. Returns null when all child options are allowed or when the child field does not have selectable options.

Nested custom-field rules

• dependency describes what controls the current field. If a field is itself a parent, it still returns dependency: null unless another field controls it.
• To find the children of a field, look for other fields where dependency.parent_field_id matches that field's id.
• For multiselect parents, the child is visible when any selected parent value appears in visible_when. If multiple selected parent values match, combine their allowed_child_options.
• allowed_child_options only filters selectable child fields (dropdown and multiselect). For child fields such as text, date, file, number, and checkbox, the dependency controls visibility only, so this value is null.

Response

200

[
  {
    "id": 1,
    "field_name": "Certification Details",
    "field_type": "text",
    "default_value": "",
    "entity_name": "candidate",
    "dependency": {
      "parent_field_id": 7,
      "parent_field_name": "Technical Skills",
      "parent_field_type": "multiselect",
      "visible_when": [
        {
          "parent_value": "Java",
          "allowed_child_options": null
        },
        {
          "parent_value": "Python",
          "allowed_child_options": null
        }
      ]
    }
  },
  {
    "id": 2,
    "field_name": "License State",
    "field_type": "text",
    "default_value": "",
    "entity_name": "candidate",
    "dependency": null
  },
  {
    "id": 3,
    "field_name": "Work Authorization Status",
    "field_type": "dropdown",
    "default_value": "Authorized,Not Authorized",
    "entity_name": "candidate",
    "dependency": null
  },
  {
    "id": 4,
    "field_name": "Follow-up Notes",
    "field_type": "text",
    "default_value": "",
    "entity_name": "candidate",
    "dependency": {
      "parent_field_id": 3,
      "parent_field_name": "Work Authorization Status",
      "parent_field_type": "dropdown",
      "visible_when": [
        {
          "parent_value": "Not Authorized",
          "allowed_child_options": null
        }
      ]
    }
  },
  {
    "id": 5,
    "field_name": "Last Verification Date",
    "field_type": "date",
    "default_value": "",
    "entity_name": "candidate",
    "dependency": null
  },
  {
    "id": 6,
    "field_name": "Supporting Document",
    "field_type": "file",
    "default_value": "",
    "entity_name": "candidate",
    "dependency": null
  },
  {
    "id": 7,
    "field_name": "Technical Skills",
    "field_type": "multiselect",
    "default_value": "Java,Python,C++,Ruby",
    "entity_name": "candidate",
    "dependency": {
      "parent_field_id": 3,
      "parent_field_name": "Work Authorization Status",
      "parent_field_type": "dropdown",
      "visible_when": [
        {
          "parent_value": "Authorized",
          "allowed_child_options": [
            "C++",
            "Ruby"
          ]
        }
      ]
    }
  },
  {
    "id": 8,
    "field_name": "Remote Eligible",
    "field_type": "checkbox",
    "default_value": "",
    "entity_name": "candidate",
    "dependency": null
  }
]

401

{
  "message": "Missing Bearer token in the header"
}