Get a kiosk device
Módulo Crew
GET/kiosk-devices/{id}kioskDevices.get
A shared device in kiosk mode. Worker PINs are stored hashed and never returned. Returns one kiosk device with its `ETag`. A kiosk device the caller may not see returns 404.
- Requiere la capacidad crew.schedule.read.
- Alcances de OAuth: crew.
- Estados de error: 400, 401, 404, 429. Los errores son detalles de problema RFC 9457.
Parámetros de ruta y de consulta
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| id | string (uuid) | Sí | Identifier of the kiosk device. |
| fields | Fields | No | Sparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Restricciones: pattern ^[a-z_][a-z0-9_]*(,[a-z_][a-z0-9_]*)*$ |
Respuesta 200: KioskDevice
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| id | string (uuid) | Sí | Identifier of the kiosk device. |
| org_id | string (uuid) | Sí | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Sí | When the row was created. |
| created_by | string (uuid) | null | Sí | Identifier of the person who created the row; null when a seed, platform or system process created it. |
| updated_at | string (date-time) | Sí | When the row was last updated. |
| updated_by | string (uuid) | null | Sí | Identifier of the person who last updated the row; null when a seed, platform or system process updated it. |
| name | string | Sí | Device name.Restricciones: length 1 to 300 |
| project_id | string (uuid) | null | Sí | Identifier of the project the kiosk serves. |
| device_key | string | null | Sí | Device key the kiosk signs in with. Returned once, in the create response; null on every read, because only its hash is kept (invariant 8).Restricciones: pattern ^xkio_[0-9a-f]{64}$ |
| last_seen_at | string (date-time) | null | Sí | Last time the kiosk checked in. |
| revoked_at | string (date-time) | null | Sí | When the kiosk was revoked; it accepts no punches. |
{
"id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"created_at": "2026-10-08T14:30:00Z",
"created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"updated_at": "2026-10-08T14:30:00Z",
"updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"name": "Gate A Kiosk",
"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"device_key": "xkio_9f2c4e1a7b3d5f6e8a0c2e4f6a8b0d2c4e6f8a0b2c4d6e8f0a2b4c6d8e0f2a4b",
"last_seen_at": "2026-10-08T14:30:00Z",
"revoked_at": "2026-10-08T14:30:00Z"
}Ejemplos de código
curl -X GET "$XOS_BASE_URL/kiosk-devices/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
-H "Authorization: Bearer $XOS_API_KEY"const { data, etag } = await xos.kioskDevices.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");response = xos.kiosk_devices.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")xos kiosk-devices get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f