v4

latestOpenAPI 3.1.02026-08-01139149645.9 KB

Screening Question

Get Screening Question By Id

Returns a ScreeningQuestion object with the given id.

get/api/ats/v1/screening-questions/{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

jobstring nullable required

The identifier of the job to which this screening question is related.

descriptionstring nullable required

A detailed description of the screening question.

titlestring nullable required

The title of the screening question.

The type of screening question. If the value is not one of the defined enum values, the original value passed through will be returned.

requiredboolean nullable required

Indicates whether answering the question is required for the applicant.

optionsobject[] nullable required

The possible options for answering the question, if applicable.

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"
  },
  "job": "018b4bfb-5ece-70b1-ad5e-862a9433aa65",
  "description": "Please describe your experience with Python.",
  "title": "Python Experience",
  "type": "SINGLE_LINE_TEXT",
  "required": true
}