Appearance

List Job form fields ​

Endpoint ​

http
GET /unified/ats/job_form_fields
Integrations supported
  • Ashby
  • Breezy
  • Greenhouse
  • Lever

Query parameters ​

Refer Specifying query parameters in Truto APIs

integrated_account_id
string · uuid
REQUIRED · 

The ID of the integrated account to use for the request.

Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_format
string

The format of the response.

  • unified will return the response with unified mappings applied.
  • raw will return the raw response from the remote API.
  • normalized will apply the unified mappings and return the data in a normalized format.

Defaults to unified.

All possible enum values:
  • unified
  • raw
  • normalized
Example: unified
truto_key_by
string

By default the result attribute is an array of objects. This parameter allows you to specify a field in each result objects to use as key, which transforms the result array into an object with the array items keyed by the field. This is useful for when you want to use the result as a lookup table.

Example: id
truto_ignore_limit
boolean

Ignores the limit query parameter.

truto_ignore_remote_data
boolean

Excludes the remote_data attribute from the response.

truto_exclude_fields
array

Array of fields to exclude from the response.

Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_query
object

Query parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.

Example: remote_query[foo]=bar
job_id
string

The job's unique identifier

Required in
  • Ashby
  • Breezy
  • Greenhouse
  • Lever
organization_id
string

The ID of the organization to filter the job form fields by.

Supported in
  • Breezy

Response Body ​

result
object[]

List of Job form fields

id
string
REQUIRED · 

The form field's unique identifier

Supported in
  • Ashby
  • Breezy
  • Greenhouse
  • Lever
name
string

The form field's name. Use this when submitting the application.

Supported in
  • Ashby
  • Breezy
  • Greenhouse
  • Lever
job
object

The form field's job

Supported in
  • Ashby
  • Breezy
  • Greenhouse
  • Lever
id
string

Unique identifier of the job

label
string

The form field's label.

Supported in
  • Ashby
  • Greenhouse
  • Lever
index
integer

The form field's position inside a form. If group_id is present, the index is relative to the group.

Supported in
  • Ashby
  • Breezy
  • Greenhouse
  • Lever
is_required
boolean

Whether the form field is required or not.

Supported in
  • Ashby
  • Breezy
  • Greenhouse
  • Lever
answer_visibility
string

The form field's answer visibility inside the ATS.

All possible enum values:
  • private
  • public
Supported in
  • Greenhouse
description
string

The form field's description.

Supported in
  • Ashby
  • Greenhouse
  • Lever
type
string

The form field's type. If no clear mapping exists, then raw value is returned.

All possible enum values:
  • text
  • textarea
  • dropdown
  • file
  • radio
  • checkbox
  • date
  • number
Supported in
  • Ashby
  • Greenhouse
  • Lever
options
object[]

The form field's options. Only present for dropdown, radio and checkbox types.

Supported in
  • Ashby
  • Greenhouse
  • Lever
id
string

The option's unique identifier

label
string

The option's label

value
string

The option's value

group_id
string

The form field's group identifier. If present, the form field is part of a group.

Supported in
  • Lever
group_name
string

The form field's group name or label. If present, the form field is part of a group.

Supported in
  • Ashby
  • Lever
remote_data
object

Raw data returned from the remote API call.

next_cursor
string

The cursor to use for the next page of results. Pass this value as next_cursor in the query parameter in the next request to get the next page of results.