Skip to main content
GET
/
api
/
ats
/
v1
/
screening-questions
/
{id}
Get Screening Question By 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": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "remote_id": "123321",
  "modified_at": "<string>",
  "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,
  "options": "Yes",
  "raw_data": {
    "key_1": "Platform dependent data 1",
    "key_2": "Platform dependent data 2"
  }
}

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<uuid>
required

Query Parameters

​
include_raw_data
boolean
default:false

Include raw data in the response

Example:

false

​
include_custom_fields
boolean
default:false

Whether to include custom fields in the response.

Example:

false

​
expand
string

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]"

Response

Successful Response

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

​
id
string<uuid>
required
Example:

"018b18ef-c487-703c-afd9-0ca478ccd9d6"

​
remote_id
string | null
required

The third-party API ID of the matching object.

Example:

"123321"

​
modified_at
string
required

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

Example:

"2021-10-16T00:00:00Z"

​
custom_fields
Custom Fields · object
required

The custom fields related to the model

Example:
{
  "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
any | null
required

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

Example:

"018b4bfb-5ece-70b1-ad5e-862a9433aa65"

​
description
string | null
required

A detailed description of the screening question.

Example:

"Please describe your experience with Python."

​
title
string | null
required

The title of the screening question.

Example:

"Python Experience"

​
type
enum<string>
required

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

Available options:
DATE,
FILE,
SINGLE_SELECT,
MULTI_SELECT,
SINGLE_LINE_TEXT,
MULTI_LINE_TEXT,
NUMERIC,
BOOLEAN
Example:

"SINGLE_LINE_TEXT"

​
required
boolean | null
required

Indicates whether answering the question is required for the applicant.

Example:

true

​
options
Options · object[] | null
required

The possible options for answering the question, if applicable.

Example:

"Yes"

​
raw_data
Raw Data · object

This is the Raw data

Example:
{
  "key_1": "Platform dependent data 1",
  "key_2": "Platform dependent data 2"
}