ATS Anywhere

ATS Anywhere Developer Hub

Welcome to the ATS Anywhere Developer Hub. You'll find comprehensive guides, documentation and use cases to help you start working with us as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started

Custom Fields Schema

Use this simple guide to customize your applications with our custom fields schema. You can create and update custom field schemas for the jobs on your site with our API.

Prerequisites

To create and update custom field schemas, you'll need to meet the following prerequisites:

  • ATS Anywhere account
  • requirement
  • requirement

Step 1: Locate Default Fields

First let’s find the custom fields you create. You can find these under the default fields of a job listing (https://yourcompanyname.com//admin/jobs/edit/###).

In the above example we created 3 new custom fields cleverly titled “My Custom Field #” which will be added for all of your job listings.

Note

Custom Fields get added automatically when you select My Custom Field in the dropdown menu.

Step 2: Recreate Fields

Before using the API, let’s look at the fields you'll be configuring via the ATS Anywhere API. Let’s go to Postman to recreate the fields in our example above.

  1. Use the PUT method with the request URL: https://YOURCOMPANY.applicant-tracking.com/api/v1/jobs/custom_fields_schema
  2. Under Headers area put in the following column values:
    Key: Content-type
    Value: application/json
  3. Under Body, select the “raw” and see if you can recreate the format as in the example.
  4. Hit “Send”.

Output

Here’s how it will look in Postman.

Note

There may be cases that a GET request may be unsuccessful. This may be because of an invalid request URL, or because authentication is needed.

Step 3: Modify Fields with cURL

You can modify your custom fields schema using cURL as well, as shown in this example.

curl -u YOUR_KEY https://YOURCOMPANY.applicant-tracking.com/api/v1/jobs/custom_fields_schema -H "Content-Type: application/json" \
  -d '{
	"update_existing_data": true,
	"custom_fields_schema": [
		{
		"field_name": "Custom Field 1",
		"field_type": "string",
    		"display_name": "My Custom Field 1",
    		"default_value": "This is your default value in a text field",
    		"required": true,
    		"whitelist_values": [],
    		"blacklist_values": [],
		"ui_priority": 0,
		"ui_readonly": true,
		"ui_input_type": "text_field",
		"ui_hints": []	    	
	    },
		{
		"field_name": "Custom Field 2",
		"field_type": "string",
    		"display_name": "My Custom Field 2",
    		"default_value": "This is your default value in a text area",
    		"required": true,
    		"whitelist_values": [],
    		"blacklist_values": [],
		"ui_priority": 2,
		"ui_readonly": false,
		"ui_input_type": "text_area",
		"ui_hints": []	    	
	    },	
	    {
		"field_name": "Custom Field 3",
		"field_type": "string",
    		"display_name": "My Custom Field 3",
    		"default_value": "This is your default value",
    		"required": true,
    		"whitelist_values": [],
    		"blacklist_values": [],
		"ui_priority": 1,
		"ui_readonly": false,
		"ui_input_type": "select",
		"ui_hints": "red"   	    	
	    }
    ]
}

Example Payload

{
    "company_id": "15664",
    "custom_fields_schema": [
        {
            "display_name": "My Custom Field 1",
            "field_type": "string",
            "default_value": "This is your default value in a text field",
            "required": true,
            "whitelist_values": [],
            "blacklist_values": [],
            "ui_priority": 0,
            "ui_readonly": true,
            "ui_input_type": "text_field",
            "ui_hints": [],
            "field_name": "Custom Field 1"
        },
        {
            "display_name": "My Custom Field 2",
            "field_type": "string",
            "default_value": "This is your default value in a text area",
            "required": true,
            "whitelist_values": [],
            "blacklist_values": [],
            "ui_priority": 2,
            "ui_readonly": false,
            "ui_input_type": "text_area",
            "ui_hints": [],
            "field_name": "Custom Field 2"
        },
        {
            "display_name": "My Custom Field 3",
            "field_type": "string",
            "default_value": "This is your default value",
            "required": true,
            "whitelist_values": [],
            "blacklist_values": [],
            "ui_priority": 1,
            "ui_readonly": false,
            "ui_input_type": "select",
            "ui_hints": [
                "red"
            ],
            "field_name": "Custom Field 3"
        }
    ],
    "created_at": "2018-03-22T20:33:47-07:00",
    "updated_at": "2018-04-01T18:39:12-07:00"
}

Note that a timestamp will be generated at the end.

Output

You will likely have more creative field names than our example below, as well as more than one option in a select list, but this just shows what is possible from the the custom field endpoint.

Once again here’s how it will appear on your site:

Step 4: List Custom Fields

Once you've added a few fields retrieving a list of custom fields is simple.

  1. Use the GET method with the request URL: https://YOURCOMPANY.applicant-tracking.com/api/v1/jobs/custom_fields_schema
  2. Under Headers area put in the following column values:
    Key: Content-type
    Value: application/json
  3. Hit Send, and within the Body frame you will see a full payload of the three jobs in our example:

Support

Need Help?

Contact our support team at this-address for more information about using custom fields schema.

Custom Fields Schema


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.