GET
/
api
/
ats
/
v1
/
screening-questions
/
{id}
curl --request GET \
  --url https://api.bindbee.dev/api/ats/v1/screening-questions/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-connector-token: <x-connector-token>'
{
  "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": "TEXT",
  "required": true,
  "options": [
    "Yes",
    "No",
    "N/A"
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
x-connector-token
string
required

Path Parameters

​
id
string
required

Query Parameters

​
include_raw_data
boolean
default:
false

Include raw data in the response

​
include_custom_fields
boolean
default:
false

Whether to include custom fields in the response.

Response

200
application/json
Successful Response

The AtsScreeningQuestion object represents a question used to screen candidates for a job within the ATS.

​
id
string
required
​
remote_id
string | null
required

The third-party API ID of the matching object.

​
modified_at
string
required

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

​
custom_fields
object | null
required

The custom fields related to the model

​
job
string | null
required

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

​
description
string | null
required

A detailed description of the screening question.

​
title
string | null
required

The title of the screening question.

​
type
string | null
required

The type of screening question, such as 'text', 'multiple-choice', etc.

​
required
boolean | null
required

Indicates whether answering the question is required for the applicant.

​
options
object[] | null
required

The possible options for answering the question, if applicable.

​
raw_data
object | null

This is the Raw data

Create Screening QuestionGet Tags