v4

latestOpenAPI 3.1.02026-08-01139149645.9 KB

Application

Get Application By Id

Returns an Application object with the given id.

get/api/ats/v1/applications/{id}

Path parameters

idstring uuid required

Query parameters

include_raw_databoolean

Include raw data in the response

include_custom_fieldsboolean

Whether to include custom fields in the response.

expandstring

Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name.

Example:manager[first_name,last_name]

Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name.

Headers

x-connector-tokenstring required

Response

Successful Response

idstring uuid required

remote_idstring nullable required

The third-party API ID of the matching object.

modified_atstring required

This is the datetime that this object was last updated by Bindbee

raw_dataobject nullable

This is the Raw data

custom_fieldsobject nullable required

The custom fields related to the model

candidatestring nullable required

The candidate associated with the application.

jobstring nullable required

The job for which the candidate has applied.

applied_atstring nullable required

The date and time when the candidate applied for the job.

rejected_atstring nullable required

The date and time when the application was rejected.

sourcestring nullable required

The source from where the candidate's application originated.

credited_tostring nullable required

The user or entity to which the application is credited.

current_stagestring nullable required

The current stage of the application in the hiring process.

reject_reasonstring nullable required

The reason for the application's rejection.

Example response

{
  "id": "018b18ef-c487-703c-afd9-0ca478ccd9d6",
  "remote_id": "123321",
  "modified_at": "2021-10-16T00:00:00Z",
  "raw_data": {
    "key_1": "Platform dependent data 1",
    "key_2": "Platform dependent data 2"
  },
  "custom_fields": {
    "category_group": "REG",
    "disability_type": "ASBERG",
    "hire_date": "1991-03-16T00:00:00",
    "hire_source": "REFER",
    "nationality": "USA",
    "original_hire_date": "1991-03-16T00:00:00"
  },
  "candidate": "018b4bfb-5ece-70b1-ad5e-862a9433aa65",
  "job": "018b4bfb-5ece-70b1-ad5e-862a9433aa65",
  "applied_at": "2021-01-01T00:00:00Z",
  "rejected_at": "2021-01-01T00:00:00Z",
  "source": "LinkedIn",
  "credited_to": "018b4bfb-5ece-70b1-ad5e-862a9433aa65",
  "current_stage": "018b4bfb-5ece-70b1-ad5e-862a9433aa65",
  "reject_reason": "018b4bfb-5ece-70b1-ad5e-862a9433aa65"
}