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.

List all machines

GET /machines

Returns a list of all visible (non-hidden) machines for the authenticated company. The data is dynamically aggregated from the main machine registry and live production logs (STATUS and MIN tables).

For each machine the response includes:

  • Operational status: current status code, rotation speed, active needle.
  • Production progress: currently loaded design, total stitches, current stitch position.
  • Efficiency metrics: completed passes (passes_pattern), estimated remaining production time.
  • Machine configuration: number of heads (incl. manual overrides), active heads detection, needles per head.

Authentication

Requires the X-API-Key header.

Query parameters

None.

Response (200 OK)

FieldTypeDescription
data[].machine_idstringUnique machine identifier (e.g. 26027).
data[].aliasstringDisplay name (e.g. ZSK Sprint 6).
data[].id_locationintegerID of the assigned location.
data[].id_datacollectorstringID of the datacollector this machine reports through.
data[].orderinteger (nullable)Sort order.
data[].headsintegerNumber of embroidery 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_machinebooleanWhether the machine is hidden.
data[].first_seenstring (date-time)
data[].last_seenstring (date-time)
data[].rpmintegerConfigured RPM from company settings.
data[].rotation_speedinteger (nullable)Current rotation speed.
data[].repeated_patterninteger (nullable)Pattern repeats configured.
data[].passes_patternintegerCompleted passes of the current design.
data[].id_designstring (nullable)Currently loaded design/pattern ID.
data[].design_stitchesinteger (nullable)Total stitches of the current design.
data[].stitchintegerCurrent stitch position in the running design.
data[].status_codeinteger (nullable)Current machine status code (see /status-codes).
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 for the current design.

Error responses

  • 401 – Missing or invalid API key.

Example

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