Signup Fields API — custom event form fields

The Signup Fields API lets you define custom form fields that appear on an event’s registration form. Each field belongs to a specific event and is identified by a fieldKey that is unique within that event. Fields support multiple input types controlled by the FieldType enum, and you can provide options, defaults, and i18n data as arbitrary JSON objects. GET endpoints are public. Creating or updating fields requires a CRUD+ role.

string (UUID)

required

Unique identifier for the signup field.

string (UUID)

required

UUID of the event this field belongs to.

string

required

Name of the event this field belongs to.

string

required

Machine-readable key unique within the event (max 120 characters). Use this key when reading submitted form data.

string

required

Human-readable label displayed on the registration form.

string

Optional helper text displayed below the field label.

string

required

Input type. One of the FieldType enum values — see the table below.

boolean

required

Whether the field must be filled in before the form can be submitted.

number

Display order of the field within the form. Lower values appear first. null if unset.

object

JSON object or array defining selectable options (used primarily with SELECT). null if not applicable.

object

JSON value representing the field’s default value. null if not set.

object

JSON object containing localised label and description strings keyed by locale code. null if not set.

string (ISO 8601)

Timestamp when the field was created.

string (ISO 8601)

Timestamp of the most recent update.

FieldType values

Value	Description
`TEXT`	Single-line text input
`TEXT_AREA`	Multi-line text input
`EMAIL`	Email address input with format validation
`NUMBER`	Numeric input
`SELECT`	Drop-down or radio selection from a predefined list in `optionsJson`
`CHECKBOX`	Boolean tick-box
`CONSENT`	Consent acknowledgement (e.g. terms and conditions)
`DATE`	Date picker

Public endpoint — no authentication required.

Returns all signup fields across all events as an unordered list.

GET /api/v1/signup-fields

Example request

cURL

curl https://chrono.pitpath.de/api/v1/signup-fields \
  -H "X-API-Key: YOUR_API_KEY"

Example response

200

[
  {
    "id": "11223344-5566-7788-99aa-bbccddeeff00",
    "eventId": "aabbccdd-eeff-0011-2233-445566778899",
    "eventName": "Summer Endurance Series 2024",
    "fieldKey": "discord_handle",
    "label": "Discord handle",
    "description": "Your Discord username including the # tag",
    "type": "TEXT",
    "required": false,
    "sortOrder": 10,
    "optionsJson": null,
    "defaultJson": null,
    "i18nJson": null,
    "createdAt": "2024-04-10T08:00:00Z",
    "updatedAt": "2024-04-10T08:00:00Z"
  }
]

Public endpoint — no authentication required.

Returns signup fields in a paginated response. Default page size is 20, sorted by sortOrder.

GET /api/v1/signup-fields/paged

Query parameters

number

default:"0"

Zero-based page index.

number

default:"20"

Number of items per page.

string

default:"sortOrder"

Field and direction, e.g. sortOrder,asc.

Example request

cURL

curl "https://chrono.pitpath.de/api/v1/signup-fields/paged?page=0&size=20" \
  -H "X-API-Key: YOUR_API_KEY"

Public endpoint — no authentication required.

Returns a single signup field by its UUID.

GET /api/v1/signup-fields/{signupFieldId}

Path parameters

The UUID of the signup field to retrieve.

Example request

cURL

curl https://chrono.pitpath.de/api/v1/signup-fields/11223344-5566-7788-99aa-bbccddeeff00 \
  -H "X-API-Key: YOUR_API_KEY"

Requires CRUD+ role.

Creates a new custom field for an event. Returns 201 Created with a Location header.

POST /api/v1/signup-fields

Request body

string (UUID)

required

UUID of the event this field belongs to.

string

required

Machine-readable key (max 120 characters). Must be unique within the event.

string

required

Display label for the field on the registration form.

string

Optional helper text displayed below the label.

string

FieldType enum value. Defaults to TEXT if omitted.

boolean

Whether the field is mandatory. Defaults to false.

number

Display position within the form. Lower values appear first.

object

Options for SELECT fields as a JSON array of choice objects. Pass null or omit for other types.

object

Default value for the field as a JSON value. Pass null or omit if there is no default.

object

Localisation data as a JSON object keyed by locale code, e.g. {"de": {"label": "Discord-Name"}}. Pass null or omit if not needed.

Example request — plain text field

cURL

curl -X POST https://chrono.pitpath.de/api/v1/signup-fields \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "eventId": "aabbccdd-eeff-0011-2233-445566778899",
    "fieldKey": "discord_handle",
    "label": "Discord handle",
    "description": "Your Discord username including the # tag",
    "type": "TEXT",
    "required": false,
    "sortOrder": 10
  }'

Example request — select field with options

cURL

curl -X POST https://chrono.pitpath.de/api/v1/signup-fields \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "eventId": "aabbccdd-eeff-0011-2233-445566778899",
    "fieldKey": "experience_level",
    "label": "Experience level",
    "type": "SELECT",
    "required": true,
    "sortOrder": 20,
    "optionsJson": [
      {"value": "beginner", "label": "Beginner"},
      {"value": "intermediate", "label": "Intermediate"},
      {"value": "expert", "label": "Expert"}
    ]
  }'

Requires CRUD+ role.

Partially updates an existing signup field. Only the fields you include are changed.

PATCH /api/v1/signup-fields/{signupFieldId}

Path parameters

The UUID of the signup field to update.

Request body

string (UUID)

UUID of the new parent event, if reassigning.

string

New machine-readable key (max 120 characters).

string

New display label.

string

New helper text.

string

New FieldType value.

boolean

Update whether the field is mandatory.

number

New display position within the form.

object

Replacement options JSON for SELECT fields.

object

Replacement default value JSON.

object

Replacement localisation JSON.

Example request

cURL

curl -X PATCH https://chrono.pitpath.de/api/v1/signup-fields/11223344-5566-7788-99aa-bbccddeeff00 \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"required": true, "sortOrder": 5}'

Example response

200

{
  "id": "11223344-5566-7788-99aa-bbccddeeff00",
  "eventId": "aabbccdd-eeff-0011-2233-445566778899",
  "eventName": "Summer Endurance Series 2024",
  "fieldKey": "discord_handle",
  "label": "Discord handle",
  "description": "Your Discord username including the # tag",
  "type": "TEXT",
  "required": true,
  "sortOrder": 5,
  "optionsJson": null,
  "defaultJson": null,
  "i18nJson": null,
  "createdAt": "2024-04-10T08:00:00Z",
  "updatedAt": "2024-07-20T10:45:00Z"
}

Overview

Endpoints

Signup Fields API — custom event form fields

FieldType values

​Signup field object

​FieldType values

​List signup fields

​List signup fields (paged)

​Get a signup field

​Create a signup field

​Update a signup field

Signup field object

FieldType values

List signup fields

List signup fields (paged)

Get a signup field

Create a signup field

Update a signup field