GET
/
fields

Authorizations

Authorization
string
headerrequired

API Key or Token formatted as Bearer <YOUR_KEY_OR_TOKEN>

Query Parameters

is_optional
boolean

Whether the field must be included to consider the process complete

dataset_id
string

Dataset id associated with the field

process_step_id
string

Process step id that the field belongs to

Response

200 - application/json
id
string

Database id for the field

company_id
string

Your company's id

is_optional
boolean

Indicates whether the field must be submitted

created_at
string

Timestamp at which the field was created.

type
enum<string>

Data entry type for the field

Available options:
MANUAL_ENTRY,
IMAGE,
CHECKBOX,
FILE,
PASSFAIL
prompt
string

Prompt that is displayed to the user

group_name
string

Group name that the field is a part of

order
number

Order in which the field appears in the process step

dataset_id
string

Id for the dataset that the field is sending data to

method
enum<string>

For fields capturing file/image data, how is that capture appearing on the production app

Available options:
CAMERA,
UPLOAD
data_validation
enum<string>

For fields with validated inputs, what validation schema is being used

Available options:
NUMBER,
INTEGER,
STRING
process_step_id
string

Which process_step does the field belong to