Skip to content
Developer

Kiosk Device

Events8 EndpointsEvent / Kiosk Device

Returns a list of KioskDevices

GET/api/event/kiosk_device

Query parameters

idinteger
deletedbooleanThis property is used to mark an entity as deleted / archived | Default value: false
namestring
deviceIdstringPublic identifier of the device, sent in the x-iw-kiosk-device-id header.
lastSeenAtstringLast request of the device.
createdstring
updatedstring
searchStringstringtext to search for in the list
orderFieldNamestringname of the order field
orderFieldSortstringsorting modeAllowed: DESCASC
pageintegerpage of the list
pageSizeintegernumber of entries for each page
withMaxPageNumberstringreturns the number of pages available as a header if this is set

Responses

200Returns a list of KioskDevicesarray<KioskDevice>

Show fields (8)
  • session_activeboolean

    Whether someone is logged in right now - for the management UI, without saying who.

  • idinteger

    Primary key of the kiosk device. Internal ID.

  • device_idstring

    Public identifier of the device, sent in the x-iw-kiosk-device-id header.

  • last_seen_atstring (date-time)

    Last request of the device.

  • namestring

    Name of the entity.

  • deletedboolean

    This property is used to mark an entity as deleted / archived

  • createdstring (date-time)

    Point in time the entity was created.

  • updatedstring (date-time)

    Point in time the entity was last updated.

Request
curl --request GET \
  --url https://your-instance.iw-erp.de/api/event/kiosk_device \
  --header 'x-iw-jwt-token: <TOKEN>'
Response 200 application/json
[
  {
    "id": 42,
    "name": "Beispiel",
    "session_active": true,
    "device_id": "42",
    "last_seen_at": "2026-10-15T09:30:00+02:00",
    "deleted": true,
    "created": "2026-10-15T09:30:00+02:00",
    "updated": "2026-10-15T09:30:00+02:00"
  }
]

Adds a new KioskDevice

POST/api/event/kiosk_device

Request body application/json

  • dataKioskDevice2
    Show fields (1)
    • deletedboolean

      This property is used to mark an entity as deleted / archived

Responses

200Add a new KioskDeviceKioskDevice

Show fields (8)
  • session_activeboolean

    Whether someone is logged in right now - for the management UI, without saying who.

  • idinteger

    Primary key of the kiosk device. Internal ID.

  • device_idstring

    Public identifier of the device, sent in the x-iw-kiosk-device-id header.

  • last_seen_atstring (date-time)

    Last request of the device.

  • namestring

    Name of the entity.

  • deletedboolean

    This property is used to mark an entity as deleted / archived

  • createdstring (date-time)

    Point in time the entity was created.

  • updatedstring (date-time)

    Point in time the entity was last updated.

Request
curl --request POST \
  --url https://your-instance.iw-erp.de/api/event/kiosk_device \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "deleted": true
  }
}
'
Response 200 application/json
{
  "id": 42,
  "name": "Beispiel",
  "session_active": true,
  "device_id": "42",
  "last_seen_at": "2026-10-15T09:30:00+02:00",
  "deleted": true,
  "created": "2026-10-15T09:30:00+02:00",
  "updated": "2026-10-15T09:30:00+02:00"
}

Returns a single KioskDevice

GET/api/event/kiosk_device/{identifier}

Path parameters

identifierrequiredstring

Responses

200Returns a single KioskDeviceKioskDevice

Show fields (8)
  • session_activeboolean

    Whether someone is logged in right now - for the management UI, without saying who.

  • idinteger

    Primary key of the kiosk device. Internal ID.

  • device_idstring

    Public identifier of the device, sent in the x-iw-kiosk-device-id header.

  • last_seen_atstring (date-time)

    Last request of the device.

  • namestring

    Name of the entity.

  • deletedboolean

    This property is used to mark an entity as deleted / archived

  • createdstring (date-time)

    Point in time the entity was created.

  • updatedstring (date-time)

    Point in time the entity was last updated.

Request
curl --request GET \
  --url https://your-instance.iw-erp.de/api/event/kiosk_device/42 \
  --header 'x-iw-jwt-token: <TOKEN>'
Response 200 application/json
{
  "id": 42,
  "name": "Beispiel",
  "session_active": true,
  "device_id": "42",
  "last_seen_at": "2026-10-15T09:30:00+02:00",
  "deleted": true,
  "created": "2026-10-15T09:30:00+02:00",
  "updated": "2026-10-15T09:30:00+02:00"
}

Updates a KioskDevice

PUT/api/event/kiosk_device/{identifier}

Path parameters

identifierrequiredstring

Request body application/json

  • dataKioskDevice2
    Show fields (1)
    • deletedboolean

      This property is used to mark an entity as deleted / archived

Responses

200Update a KioskDeviceKioskDevice

Show fields (8)
  • session_activeboolean

    Whether someone is logged in right now - for the management UI, without saying who.

  • idinteger

    Primary key of the kiosk device. Internal ID.

  • device_idstring

    Public identifier of the device, sent in the x-iw-kiosk-device-id header.

  • last_seen_atstring (date-time)

    Last request of the device.

  • namestring

    Name of the entity.

  • deletedboolean

    This property is used to mark an entity as deleted / archived

  • createdstring (date-time)

    Point in time the entity was created.

  • updatedstring (date-time)

    Point in time the entity was last updated.

Request
curl --request PUT \
  --url https://your-instance.iw-erp.de/api/event/kiosk_device/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "deleted": true
  }
}
'
Response 200 application/json
{
  "id": 42,
  "name": "Beispiel",
  "session_active": true,
  "device_id": "42",
  "last_seen_at": "2026-10-15T09:30:00+02:00",
  "deleted": true,
  "created": "2026-10-15T09:30:00+02:00",
  "updated": "2026-10-15T09:30:00+02:00"
}

Updates a KioskDevice

PATCH/api/event/kiosk_device/{identifier}

Path parameters

identifierrequiredstring

Request body application/json

  • dataKioskDevice2
    Show fields (1)
    • deletedboolean

      This property is used to mark an entity as deleted / archived

Responses

200Update a KioskDeviceKioskDevice

Show fields (8)
  • session_activeboolean

    Whether someone is logged in right now - for the management UI, without saying who.

  • idinteger

    Primary key of the kiosk device. Internal ID.

  • device_idstring

    Public identifier of the device, sent in the x-iw-kiosk-device-id header.

  • last_seen_atstring (date-time)

    Last request of the device.

  • namestring

    Name of the entity.

  • deletedboolean

    This property is used to mark an entity as deleted / archived

  • createdstring (date-time)

    Point in time the entity was created.

  • updatedstring (date-time)

    Point in time the entity was last updated.

Request
curl --request PATCH \
  --url https://your-instance.iw-erp.de/api/event/kiosk_device/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "deleted": true
  }
}
'
Response 200 application/json
{
  "id": 42,
  "name": "Beispiel",
  "session_active": true,
  "device_id": "42",
  "last_seen_at": "2026-10-15T09:30:00+02:00",
  "deleted": true,
  "created": "2026-10-15T09:30:00+02:00",
  "updated": "2026-10-15T09:30:00+02:00"
}

Deletes a single KioskDevice

DELETE/api/event/kiosk_device/{identifier}

Path parameters

identifierrequiredstring

Responses

200Deletes a single KioskDeviceKioskDevice

Show fields (8)
  • session_activeboolean

    Whether someone is logged in right now - for the management UI, without saying who.

  • idinteger

    Primary key of the kiosk device. Internal ID.

  • device_idstring

    Public identifier of the device, sent in the x-iw-kiosk-device-id header.

  • last_seen_atstring (date-time)

    Last request of the device.

  • namestring

    Name of the entity.

  • deletedboolean

    This property is used to mark an entity as deleted / archived

  • createdstring (date-time)

    Point in time the entity was created.

  • updatedstring (date-time)

    Point in time the entity was last updated.

Request
curl --request DELETE \
  --url https://your-instance.iw-erp.de/api/event/kiosk_device/42 \
  --header 'x-iw-jwt-token: <TOKEN>'
Response 200 application/json
{
  "id": 42,
  "name": "Beispiel",
  "session_active": true,
  "device_id": "42",
  "last_seen_at": "2026-10-15T09:30:00+02:00",
  "deleted": true,
  "created": "2026-10-15T09:30:00+02:00",
  "updated": "2026-10-15T09:30:00+02:00"
}

Returns the pairing code the kiosk app scans or receives typed in.

GET/api/event/kiosk_device/{identifier}/pairing

Separate from the detail endpoint so the secret is fetched deliberately and appears in exactly one response.

Path parameters

identifierrequiredstring

Responses

200Pairing codeobject

Show fields (2)
  • device_idstring
  • pairing_codestring
Request
curl --request GET \
  --url https://your-instance.iw-erp.de/api/event/kiosk_device/42/pairing \
  --header 'x-iw-jwt-token: <TOKEN>'
Response 200 application/json
{
  "device_id": "42",
  "pairing_code": "string"
}

Issues a new secret and ends the running session. The kiosk has to be paired again with the new code.

POST/api/event/kiosk_device/{identifier}/rotate_secret

Path parameters

identifierrequiredstring

Responses

default

Request
curl --request POST \
  --url https://your-instance.iw-erp.de/api/event/kiosk_device/42/rotate_secret \
  --header 'x-iw-jwt-token: <TOKEN>'