MyZSK API

The MyZSK API is a read-only REST interface that allows for the retrieval of embroidery data, machine statuses, and analytics from the MyZSK platform. It is designed for the programmatic analysis of production, thread breaks, shifts, and operators.

Get a single machine

GET /machines/{machineId}

Returns detailed real-time information for a specific machine. The machine must belong to the authenticated company.

The response includes the machine’s configuration and its current operational state:

  • Live monitoring: current status, stitch counter and active needle position.
  • Pattern information: details of the design currently being processed, including passes_pattern.
  • Time estimation: estimate_time_remaining based on the configured RPM and remaining stitches.
  • Hardware details: heads and needles.

Authentication

Requires the X-API-Key header.

Path parameters

machineId (string, required) – the machine identifier (e.g. 26027).

Response (200 OK)

FieldTypeDescription
data.machine_idstringe.g. 26027.
data.aliasstringe.g. ZSK Sprint 6.
data.id_locationinteger
data.id_datacollectorstring
data.orderinteger (nullable)
data.headsintegerNumber of heads (manual override if set).
data.active_headsintegerNumber of currently active heads.
data.active_needleinteger (nullable)Currently active needle number.
data.needlesintegerNumber of needles per head.
data.hide_machineboolean
data.first_seenstring (date-time)
data.last_seenstring (date-time)
data.rpmintegerConfigured RPM from company settings.
data.rotation_speedinteger (nullable)Current rotation speed.
data.id_designstring (nullable)Currently loaded design/pattern ID.
data.design_stitchesinteger (nullable)Total stitches of the current design.
data.stitchintegerCurrent stitch position.
data.status_codeinteger (nullable)Current machine status code.
data.repeated_patterninteger (nullable)Pattern repeats configured.
data.passes_patternintegerCompleted passes of the current design.
data.pattern_stitchcounterinteger (nullable)Pattern stitch counter from machine.
data.pattern_stitchnumberinteger (nullable)Current pattern stitch number.
data.stitch_typeinteger (nullable)Current stitch type.
data.estimate_time_remaininginteger (nullable)Estimated seconds remaining.

Error responses

  • 404 – Machine not found or not accessible.

Parameters

Parameter Type Description Required
machineId string (path) The machine identifier (e.g. 26027). Yes

Example

curl -H "X-API-Key: $MYZSK_API_KEY" \
     "https://my.zsk.de/customer-api/machines/26027"