Get form fields

Returns the configured check-in form fields for a gallery.

Written by Exportlab · Updated March 2026

GET /group-shoot/checkin/{token}/form-fields

Returns the configured check-in form fields for a gallery, useful for building your own check-in UI or for mapping customFields values from the persons endpoint to human-readable labels.

bash

Copied

curl -X GET "https://api.exportlab.io/v1/group-shoot/checkin/{TOKEN}/form-fields" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "X-Tenant-Slug: YOUR_TENANT"

json

Copied

{
  "ok": true,
  "galleryToken": "iURWUkHo",
  "formFields": [
    {
      "key": "employeeId",
      "label": "Employee ID",
      "type": "text",
      "required": false
    },
    {
      "key": "custom-a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "label": "T-shirt size",
      "type": "select",
      "required": true,
      "options": [
        { "value": "S", "label": "S" },
        { "value": "M", "label": "M" },
        { "value": "L", "label": "L" },
        { "value": "XL", "label": "XL" }
      ]
    }
  ]
}

Only enabled fields are returned. Name and email are always required and are not included in this list.

Use the key to map customFields values from GET /persons. For example customFields["custom-a1b2c3d4-..."] corresponds to the field with that key.

Path parameter	Type	Description
token	string	The gallery token

Field	Type	Description
key	string	Field identifier. Built-in: employeeId, phone, department, notes. Custom: custom-{uuid}
label	string	Display label as configured by the admin
type	string	text, textarea, number, or select
required	boolean	Whether the field must be filled in
options	array	Only present when type is select. Each entry has value and label