get https://{subdomain}.workable.com/spi/v3/jobs//application_form
Returns the application form details for the specified job. Required scope: r_jobs. Accessible with all token types.
Results
Calling the /jobs/:shortcode/application_form endpoint returns a JSON object with two arrays, one with the application form fields and one array with the job's questions.
This endpoint might be handy if you want to build a dynamic application form that will conform with the rules defined in the "Application Form" tab of Job Editor.
| key | description |
|---|---|
| form_fields | array of form fields |
| questions | array of questions |
Each question has the following keys:
| key | type | description |
|---|---|---|
| id | string | The question's id |
| body | string | The question's body |
| type | string | The question's type. Possible values are free_text, multiple_choice, boolean, dropdown, numeric, date, file |
| required | boolean | Specifies whether providing an answer for this question is required |
| single_answer | boolean | Defined only if question's type is multiple_choice |
| choices | array | Defined only if question's type is multiple_choice or dropdown. An array specifying the possible answers. |
| choices/id | string | The choice's id |
| choices/body | string | The choice's text |
| supported_file_types | array | Defined only if question type is file. An array specifying the accepted file types for this question. |
| max_file_size | integer | Defined only if question type is file. The maximum file size in bytes. |
Each form_field has the following keys:
| key | type | description |
|---|---|---|
| key | string | The application form's field key. This key matches with the candidate attribute as well |
| label | string | The fields name. |
| type | string | The fields type. Possible values are: string, free_text, file, boolean, date, complex |
| required | boolean | Indicates if this field is mandatory |
| fields | array | Defined in fields of type complex |
| supported_file_types | array | Defined in fields of type file |
| max_file_size | integer | Defined in fields of type file |