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 designs / patterns

GET /designs

Returns all embroidery designs (patterns) for the authenticated company, including stitch count. Supports paging via the page and limit query parameters.

Authentication

Requires the X-API-Key header.

Query parameters

NameTypeRequiredDescription
pageinteger (query, default 1)noPage number for paginating the result set.
limitinteger (query, default 100, max 1000)noNumber of items per page. Maximum allowed value is 1000.

Response (200 OK)

FieldTypeDescription
data[].idstringPattern identifier (e.g. DESIGN_001).
data[].namestringDesign name (e.g. Rose Border).
data[].stitchesintegerTotal stitch count of the design (e.g. 45000).
data[].date_insertedstring (date-time)When the design was added.
totalintegerTotal number of designs.
pageintegerCurrent page number.
limitintegerItems per page used for this response.

Example response

{
  "data": [
    { "id": "DESIGN_001", "name": "Rose Border", "stitches": 45000, "date_inserted": "2024-08-15T10:23:00Z" }
  ],
  "total": 128,
  "page": 1,
  "limit": 100
}

Parameters

Parameter Type Description Required
page integer (query, default 1) Page number for paginating the result set. No
limit integer (query, default 100, max 1000) Number of items per page. Maximum allowed value is 1000. No

Example

curl -H "X-API-Key: $MYZSK_API_KEY" \
     "https://my.zsk.de/customer-api/designs?page=1&limit=100"