Kiosk

object

idrequired: Id
Opaque record id.
namerequired: string
site_namerequired: string
statusrequired: "pending" | "active" | "revoked"
token_prefixrequired: string
Letter of its queue tokens ("A" → A-1, A-2 …).
token_hintrequired: string or null
Last characters of the device token.
projectrequired: object or null
project.idrequired: Id
Opaque record id.
project.namerequired: string
sourcerequired: object or null
source.idrequired: Id
Opaque record id.
source.namerequired: string
settingsrequired: KioskSettings
notify_membersrequired: array of object
notify_members[].idrequired: Id
Opaque record id.
notify_members[].namerequired: string
default_ownerrequired: object or null
default_owner.idrequired: Id
Opaque record id.
default_owner.namerequired: string
paired_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
last_seen_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
app_versionrequired: string or null
revoked_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
pairing_expires_atrequired: DateTime or null
A pairing code waits to be used until then.
kiosk_urlrequired: string
Where the tablet opens the kiosk.
walk_ins_todayrequired: integer
created_atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
updated_atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.

Example

{
  "id": "cmusrceel0000q7kaafxqi1om",
  "name": "string",
  "site_name": "string",
  "status": "pending",
  "token_prefix": "string",
  "token_hint": "string",
  "project": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string"
  },
  "source": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string"
  },
  "settings": {
    "welcome_title": "string",
    "welcome_text": "string",
    "accent": "string",
    "language": "en",
    "otp": "required",
    "ask_lead_type": true,
    "configurations": [
      "string"
    ],
    "budget_bands": [
      {
        "key": "string",
        "label": "string",
        "min": 0,
        "max": 0
      }
    ],
    "came_via": [
      "walk_in"
    ],
    "ask_email": true,
    "ask_notes": true,
    "notify_member_ids": [
      "cmusrceel0000q7kaafxqi1om"
    ],
    "default_owner_id": "cmusrceel0000q7kaafxqi1om",
    "idle_reset_sec": 0
  },
  "notify_members": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    }
  ],
  "default_owner": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string"
  },
  "paired_at": "2026-10-06T05:30:00.000Z",
  "last_seen_at": "2026-10-06T05:30:00.000Z",
  "app_version": "string",
  "revoked_at": "2026-10-06T05:30:00.000Z",
  "pairing_expires_at": "2026-10-06T05:30:00.000Z",
  "kiosk_url": "string",
  "walk_ins_today": 0,
  "created_at": "2026-10-06T05:30:00.000Z",
  "updated_at": "2026-10-06T05:30:00.000Z"
}

{ "id": "cmusrceel0000q7kaafxqi1om", "name": "string", "site_name": "string", "status": "pending", "token_prefix": "string", "token_hint": "string", "project": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" }, "source": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" }, "settings": { "welcome_title": "string", "welcome_text": "string", "accent": "string", "language": "en", "otp": "required", "ask_lead_type": true, "configurations": [ "string" ], "budget_bands": [ { "key": "string", "label": "string", "min": 0, "max": 0 } ], "came_via": [ "walk_in" ], "ask_email": true, "ask_notes": true, "notify_member_ids": [ "cmusrceel0000q7kaafxqi1om" ], "default_owner_id": "cmusrceel0000q7kaafxqi1om", "idle_reset_sec": 0 }, "notify_members": [ { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" } ], "default_owner": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" }, "paired_at": "2026-10-06T05:30:00.000Z", "last_seen_at": "2026-10-06T05:30:00.000Z", "app_version": "string", "revoked_at": "2026-10-06T05:30:00.000Z", "pairing_expires_at": "2026-10-06T05:30:00.000Z", "kiosk_url": "string", "walk_ins_today": 0, "created_at": "2026-10-06T05:30:00.000Z", "updated_at": "2026-10-06T05:30:00.000Z" }