Skip to main content
GET
/
fields
Get Fields
curl --request GET \
  --url https://api.serial.io/fields \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "company_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "is_optional": true,
    "created_at": "2023-11-07T05:31:56Z",
    "type": "MANUAL_ENTRY",
    "prompt": "<string>",
    "group_name": "<string>",
    "order": 123,
    "dataset_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "method": "CAMERA",
    "data_validation": "NUMBER",
    "process_step_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
]

Authorizations

​
Authorization
string
header
required

Query Parameters

​
is_optional
boolean
​
dataset_id
string
​
process_step_id
string

Response

​
id
string<uuid>
​
company_id
string<uuid>
​
is_optional
boolean
​
created_at
string<date-time>
​
type
enum<string>
Available options:
MANUAL_ENTRY,
IMAGE,
CHECKBOX,
FILE,
PASSFAIL
​
prompt
string
​
group_name
string
​
order
number
​
dataset_id
string<uuid>
​
method
enum<string>
Available options:
CAMERA,
UPLOAD
​
data_validation
enum<string>
Available options:
NUMBER,
INTEGER,
STRING
​
process_step_id
string<uuid>