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 work periods (shifts)

GET /work-periods

Returns all configured work periods / shift definitions for the authenticated company. The returned shift IDs can be used together with the shift query parameter on most report endpoints.

Authentication

Requires the X-API-Key header.

Query parameters

None.

Response (200 OK)

FieldTypeDescription
data[].idintegerWork period / shift identifier.
data[].namestringName of the shift (e.g. "Early Shift").
data[].id_companyintegerID of the owning company.
data[].timezonestringIANA time zone identifier (e.g. "Europe/Berlin").

Example response

{
  "data": [
    { "id": 1, "name": "Early Shift", "id_company": 42, "timezone": "Europe/Berlin" }
  ]
}

Example

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