Mallit

curl "https://getqr.com/api/v1/templates?page=1&pageSize=100" \
  -H "Authorization: Bearer $GETQR_API_KEY"

{
  "data": [
    {
      "id": "qrt_8Hs2mQvKpLd4RtYw",
      "name": "Brand blue",
      "designKind": "custom",
      "design": {
        "styles": {
          "dotsOptions": { "type": "rounded", "color": "#1E40AF" },
          "backgroundOptions": { "color": "#FFFFFF" }
        },
        "frameOptions": null,
        "logoOptions": null
      },
      "createdAt": "2026-07-20T09:12:00.000Z",
      "updatedAt": "2026-07-20T09:12:00.000Z"
    }
  ],
  "pagination": { "page": 1, "pageSize": 100, "total": 1, "hasMore": false }
}

curl "https://getqr.com/api/v1/templates?page=1&pageSize=100" \
  -H "Authorization: Bearer $GETQR_API_KEY"

{
  "data": [
    {
      "id": "qrt_8Hs2mQvKpLd4RtYw",
      "name": "Brand blue",
      "designKind": "custom",
      "design": {
        "styles": {
          "dotsOptions": { "type": "rounded", "color": "#1E40AF" },
          "backgroundOptions": { "color": "#FFFFFF" }
        },
        "frameOptions": null,
        "logoOptions": null
      },
      "createdAt": "2026-07-20T09:12:00.000Z",
      "updatedAt": "2026-07-20T09:12:00.000Z"
    }
  ],
  "pagination": { "page": 1, "pageSize": 100, "total": 1, "hasMore": false }
}

GetQR API on beetavaiheessa, ja se on käytettävissä valituissa työtiloissa. Yksityiskohdat voivat muuttua ennen yleistä julkaisua.

Malli tallentaa uudelleenkäytettävän ulkoasun: styles, frameOptions ja logoOptions. Se ei koskaan sisällä sisältöä tai linkkiä. Mallit jaetaan kaikkien työtilan jäsenten kesken.

Metodi	Polku	Kuvaus
`GET`	`/api/v1/templates`	Listaa mallit
`POST`	`/api/v1/templates`	Luo malli
`GET`	`/api/v1/templates/{templateId}`	Hae malli
`PATCH`	`/api/v1/templates/{templateId}`	Päivitä malli
`DELETE`	`/api/v1/templates/{templateId}`	Poista malli
`POST`	`/api/v1/templates/{templateId}/duplicate`	Monista malli

Mallin käyttäminen

Välitä templateId, kun luot QR-koodin. Mallin ulkoasu otetaan uuteen QR-koodiin. Samassa pyynnössä lähettämäsi ulkoasuobjektit yhdistetään sen päälle.

Kopioitu, ei linkitetty. QR-koodi säilyttää oman kopionsa ulkoasusta. Mallin muokkaaminen tai poistaminen myöhemmin ei muuta sitä.
Vain mukautetut ulkoasut. Mallia, jonka designKind on branded tai ai, ei voi käyttää API:n kautta, ja se palauttaa 422 (art_template_unsupported).
Vain oma työtilasi. Tuntematon malli tai toisen työtilan malli palauttaa 404.

Otsakkeet

string

vaadittu

Bearer ja sen perässä API-avaimesi. Katso Todennus.

string

application/json. Pakollinen pyynnöissä, joissa on runko.

Malliobjekti

string

Mallin tunnus, esimerkiksi qrt_8Hs2mQvKpLd4RtYw.

string

Nimi, joka näkyy mallia valittaessa.

string

Vain luku. custom on ulkoasu, jota API voi muokata kokonaan. branded ja ai ovat hallintapaneelissa tehty brändätty tai tekoälyllä luotu ulkoasu: sen kuvaa ei voi muokata API:n kautta, ja se säilyy, kun muutat muita ulkoasukenttiä.

object

Tallennettu ulkoasu. Kullakin kentällä on sama rakenne kuin samannimisellä pyynnön kentällä, joten voit lähettää sen takaisin.

Näytä properties

object | null

Pisteiden ja kulmien muodot sekä värit.

object | null

QR-koodia ympäröivä kehys ja sen toimintakehote.

object | null

Logo keskellä.

string

Luontipäivä, ISO 8601.

string

Viimeisimmän päivityksen päivä, ISO 8601.

Listaa mallit

GET /api/v1/templates Palauttaa työtilasi mallit, uusimmat ensin. Lista on sivutettu: katso Sivutus.

integer

oletus:"1"

Palautettava sivu, 1 tai suurempi.

integer

oletus:"100"

Tuloksia sivua kohti, 1–100.

curl "https://getqr.com/api/v1/templates?page=1&pageSize=100" \
  -H "Authorization: Bearer $GETQR_API_KEY"

{
  "data": [
    {
      "id": "qrt_8Hs2mQvKpLd4RtYw",
      "name": "Brand blue",
      "designKind": "custom",
      "design": {
        "styles": {
          "dotsOptions": { "type": "rounded", "color": "#1E40AF" },
          "backgroundOptions": { "color": "#FFFFFF" }
        },
        "frameOptions": null,
        "logoOptions": null
      },
      "createdAt": "2026-07-20T09:12:00.000Z",
      "updatedAt": "2026-07-20T09:12:00.000Z"
    }
  ],
  "pagination": { "page": 1, "pageSize": 100, "total": 1, "hasMore": false }
}

Luo malli

POST /api/v1/templates Tallentaa uuden ulkoasun. Vastaa 201 Created. Ulkoasukentät tarkistetaan Mukauttaminen-oppaan luetteloita vasten, joten tuntematon muoto, kehys tai logo hylätään koodilla 422.

string

vaadittu

Nimi, joka näkyy mallia valittaessa, 1–40 merkkiä.

object

Pisteiden ja kulmien muodot sekä värit. Katso Mukauttaminen.

object

QR-koodin ympärille piirretty kehys ja sen toimintakehote. Katso Mukauttaminen.

object

Keskelle sijoitettu logo: ehdotettu logo tai oma tiedostosi, joka on ladattu Tiedostot-päätepisteen targetilla logo. Katso Mukauttaminen.

curl -X POST "https://getqr.com/api/v1/templates" \
  -H "Authorization: Bearer $GETQR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Brand blue",
    "styles": {
      "dotsOptions": { "type": "rounded", "color": "#1E40AF" },
      "backgroundOptions": { "color": "#FFFFFF" }
    }
  }'

{
  "id": "qrt_8Hs2mQvKpLd4RtYw",
  "name": "Brand blue",
  "designKind": "custom",
  "design": {
    "styles": {
      "dotsOptions": { "type": "rounded", "color": "#1E40AF" },
      "backgroundOptions": { "color": "#FFFFFF" }
    },
    "frameOptions": null,
    "logoOptions": null
  },
  "createdAt": "2026-07-20T09:12:00.000Z",
  "updatedAt": "2026-07-20T09:12:00.000Z"
}

Hae malli

GET /api/v1/templates/{templateId}

string

vaadittu

Mallin tunnus. Ota se listauksen tai luonnin vastauksesta.

curl "https://getqr.com/api/v1/templates/qrt_8Hs2mQvKpLd4RtYw" \
  -H "Authorization: Bearer $GETQR_API_KEY"

{
  "id": "qrt_8Hs2mQvKpLd4RtYw",
  "name": "Brand blue",
  "designKind": "custom",
  "design": {
    "styles": {
      "dotsOptions": { "type": "rounded", "color": "#1E40AF" },
      "backgroundOptions": { "color": "#FFFFFF" }
    },
    "frameOptions": null,
    "logoOptions": null
  },
  "createdAt": "2026-07-20T09:12:00.000Z",
  "updatedAt": "2026-07-20T09:12:00.000Z"
}

Päivitä malli

PATCH /api/v1/templates/{templateId} Lähetä vain ne kentät, joita haluat muuttaa. Ulkoasuobjektit yhdistetään tallennettuun ulkoasuun, joten osittainen styles säilyttää loput. Mallista jo luodut QR-koodit säilyttävät ulkoasun, jolla ne tehtiin.

string

vaadittu

Mallin tunnus.

string

Uusi nimi, 1–40 merkkiä.

object

Tyylimuutokset, jotka yhdistetään tallennettuun styles-objektiin.

object

Kehysmuutokset, jotka yhdistetään tallennettuun kehykseen.

object

Logomuutokset, jotka yhdistetään tallennettuun logoon.

curl -X PATCH "https://getqr.com/api/v1/templates/qrt_8Hs2mQvKpLd4RtYw" \
  -H "Authorization: Bearer $GETQR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "name": "Brand blue (2026)" }'

{
  "id": "qrt_8Hs2mQvKpLd4RtYw",
  "name": "Brand blue (2026)",
  "designKind": "custom",
  "design": {
    "styles": {
      "dotsOptions": { "type": "rounded", "color": "#1E40AF" },
      "backgroundOptions": { "color": "#FFFFFF" }
    },
    "frameOptions": null,
    "logoOptions": null
  },
  "createdAt": "2026-07-20T09:12:00.000Z",
  "updatedAt": "2026-08-14T09:00:00.000Z"
}

Poista malli

DELETE /api/v1/templates/{templateId} Poistaa mallin. Siitä luodut QR-koodit säilyttävät ulkoasunsa.

string

vaadittu

Mallin tunnus.

curl -X DELETE "https://getqr.com/api/v1/templates/qrt_8Hs2mQvKpLd4RtYw" \
  -H "Authorization: Bearer $GETQR_API_KEY"

{ "id": "qrt_8Hs2mQvKpLd4RtYw", "deleted": true }

Monista malli

POST /api/v1/templates/{templateId}/duplicate Luo kopion nimellä <name> copy. Kopiolla on oma tunnus ja itsenäinen ulkoasu, jota voit muokata vapaasti. Ei ota pyynnön runkoa. Vastaa 201 Created.

string

vaadittu

Kopioitavan mallin tunnus.

curl -X POST "https://getqr.com/api/v1/templates/qrt_8Hs2mQvKpLd4RtYw/duplicate" \
  -H "Authorization: Bearer $GETQR_API_KEY"

{
  "id": "qrt_2Kd9pLm4Xs7BnVcQ",
  "name": "Brand blue copy",
  "designKind": "custom",
  "design": {
    "styles": {
      "dotsOptions": { "type": "rounded", "color": "#1E40AF" },
      "backgroundOptions": { "color": "#FFFFFF" }
    },
    "frameOptions": null,
    "logoOptions": null
  },
  "createdAt": "2026-08-14T09:30:00.000Z",
  "updatedAt": "2026-08-14T09:30:00.000Z"
}

Yleisiä ongelmia

404 "QR template not found."

templateId ei vastaa työtilasi mallia. Ota se kohdasta Listaa mallit.

422 mallia luotaessa tai päivitettäessä

Jokin ulkoasukenttä ei vastaa luetteloita, esimerkiksi tuntematon pistetyyppi, kehys tai ehdotettu logo. Viesti nimeää kentän. Katso Mukauttaminen.

422 art_template_unsupported QR-koodia luotaessa

Malli käyttää brändättyä tai tekoälyllä luotua ulkoasua. Käytä sen sijaan mallia, jonka designKind on custom.

API

Mallin käyttäminen

Otsakkeet

Malliobjekti

Listaa mallit

Luo malli

Hae malli

Päivitä malli

Poista malli

Monista malli

Yleisiä ongelmia

Mitä seuraavaksi

Mukauttaminen

QR-koodit

Mallit sovelluksessa

Tiedostot

​Mallin käyttäminen

​Otsakkeet

​Malliobjekti

​Listaa mallit

​Luo malli

​Hae malli

​Päivitä malli

​Poista malli

​Monista malli

​Yleisiä ongelmia

​Mitä seuraavaksi

Mukauttaminen

QR-koodit

Mallit sovelluksessa

Tiedostot

Mallin käyttäminen

Otsakkeet

Malliobjekti

Listaa mallit

Luo malli

Hae malli

Päivitä malli

Poista malli

Monista malli

Yleisiä ongelmia

Mitä seuraavaksi