AtsField

AtsField represents a ATS field step in the Flow builder in the Recrubo platform. The ats field object contains all the information about the field, such as identifier, label, data_type, description, allowed_values, and formatted_question. To use the ATS field step in the Flow builder, ATS Fields first need to be created in Recrubo.

Endpoints

• GET /ats-fields - Retrieves a list of all ats fields.

• GET /ats-fields/{id} - Retrieves a specific ats field by ID.

• POST /ats-fields - Creates a new ats field.

• PATCH /ats-fields/{id} - Updates a specific ats field by ID.

• DELETE /ats-fields/{id} - Deletes a specific ats field by ID.

Attributes

Field	Type	Description
identifier	String	The identifier or name for the ats field.
label	String	The label for the ats field.
data_type	String	The data type for the ats field.
description	String	The description for the ats field.
allowed_values	Array	The allowed values for AI field mapping for the ats field.
formatted_question	String	An override for the question generated by AI during flow generation, if you want more control.

HTTP Methods

Field	GET	POST	PATCH
identifier	X	X	x
label	X	X	X
data_type	X	x	x
description	X	x	x
allowed_values	X	X	X
formatted_question	X	X	X

Required Fields for Creation (POST)

Field	Type	Example value
identifier	String	work_permit
data_type	String	string

Example POST body

{
  "data": {
    "type": "ats-fields",
    "attributes": {
      "identifier": "work_permit",
      "data_type": "string",
      "label": "Work permit",
      "description": "Does the candidate have a valid work permit for the Netherlands",
      "allowed_values": ["yes", "no"],
      "formatted_question": "Do you require sponsorship to work in the Netherlands?"
    }
  }
}

Example PATCH body

{
  "data": {
    "type": "ats-fields",
    "attributes": {
      "identifier": "work_permit"
    }
  }
}