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

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

OK

The response is of type field · object[].

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

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

OK

The response is of type field · object[].