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.

Response

200

[
  {
    "id": 1,
    "field_name": "Credentials",
    "field_type": "text",
    "default_value": "",
    "entity_name": "candidate"
  },
  {
    "id": 3,
    "field_name": "License Status",
    "field_type": "dropdown",
    "default_value": "Active,Inactive",
    "entity_name": "candidate"
  },
  {
    "id": 5,
    "field_name": "Last Contact Date",
    "field_type": "date",
    "default_value": "",
    "entity_name": "candidate"
  }
]

401

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