In order to edit field go to Settings-->Fields Configuration and choose which entity fields you want to configure. 

Select field you want to edit.  In order to show it up in API you need to do two things:

  • add SID value to the field
  • turn on 'Field available via integration' switch

Fields with SIDs show up in API with '_' prefix. In a given example in the candidate data there is a custom field with SID available_from. From now on, this field:

  •  is returned in the candidate data via API (and can be used for filtering/sorting),
  •  is available for POST/PATCH/PUT requests. 

For example, any single candidate's response in API with GET request with additional Available from field will look like this: 

    "id": 2288876,
    "name": "Test",
    "lastname": "Candidate",
    "status": "active",
    "files": [],
    "email": "[email protected]",
    "created_at": "2013-12-13 11:19:45",
    "updated_at": "2020-02-25 08:33:08",
    "updated_by": {
      "id": 1794
    "_available_from": "2020-02-29",

For now, we don't support File, Files and Location custom fields in API. 

Did this answer your question?