QR-koder - GetQR Docs

GetQR API-et er i beta og er tilgjengelig for utvalgte arbeidsområder. Detaljer kan endres før den generelle lanseringen.

En QR-kode i GetQR er bildet pluss en kortlenke som den løses gjennom. Når du oppretter en QR-kode, opprettes også kortlenken, så du kan endre målet senere uten å trykke koden på nytt.

Metode	Bane	Beskrivelse
`GET`	`/api/v1/qrs`	Vis QR-koder
`POST`	`/api/v1/qrs`	Opprett en QR-kode
`GET`	`/api/v1/qrs/{qrId}`	Hent en QR-kode
`PATCH`	`/api/v1/qrs/{qrId}`	Oppdater en QR-kode
`PUT`	`/api/v1/qrs/{qrId}`	Angi pausestatus
`POST`	`/api/v1/qrs/{qrId}/pause`	Sett en QR-kode på pause
`POST`	`/api/v1/qrs/{qrId}/activate`	Reaktiver en QR-kode
`POST`	`/api/v1/qrs/{qrId}/duplicate`	Dupliser en QR-kode
`DELETE`	`/api/v1/qrs/{qrId}`	Slett en QR-kode
`GET`	`/api/v1/qrs/{qrId}/download`	Last ned et QR-kodebilde

QR-kodedata per type

data-formatet for hver av de 16 typene.

Tilpasning

Prikkstiler, farger, rammer og logoer.

Tilgangsregler

Tidsplan, skannegrense og passord.

Se Analyse for skannestatistikk for en QR-kode.

QR-kodeobjektet

Alle QR-kode-endepunkter svarer med dette objektet, unntatt Slett og Last ned. Listen returnerer en matrise av dem.

string

Unik ID for QR-koden, for eksempel qr_1EPcVfeHZAY2iNoVLsgW2Aqf.

string

QR-kodetype, for eksempel website. Se QR-kodedata per type for alle 16 verdiene.

string | null

Navnet på QR-koden, som vises i dashbordet.

string | null

Fritt notat om QR-koden.

string

Den lagrede payloaden. For wifi, vcard, social, multilink, event og sms er det payloaden du sendte. For alle andre typer er det kortlenken, så les målet fra url.

boolean

true når QR-koden er satt på pause.

boolean

true for en statisk QR-kode laget i dashbordet, som ikke har noen kortlenke. API-et oppretter alltid dynamiske QR-koder.

string | null

Hele kortlenken, for eksempel https://getqr.sh/x7Kd2p1.

string | null

Domenet til kortlenken.

string | null

Slugen til kortlenken.

boolean

true når slugen er valgt i stedet for generert.

string | null

Målet kortlenken videresender til.

string | null

Mål for besøkende på iOS, for app-QR-koder.

string | null

Mål for besøkende på Android, for app-QR-koder.

integer

Totalt antall skanninger.

object

Tilgangsregler. Selve passordet returneres aldri. Se Tilgangsregler.

Vis properties

boolean

Om besøkende må skrive inn et passord.

string | null

Planlagt start, ISO 8601.

string | null

Planlagt slutt, ISO 8601.

integer | null

Maksimalt antall skanninger.

string

Skrivebeskyttet. custom er et design som API-et kan redigere fullt ut. branded og ai er et Branded design eller AI design laget i dashbordet. API-et kan ikke redigere bildet, men beholder det når du endrer andre felt.

object

Det lagrede designet: styles, frameOptions og logoOptions, hver et objekt eller null. De har samme form som feltene i forespørselen, så du kan sende dem tilbake. Se Tilpasning.

object | null

Filen til en pdf-, image- eller video-QR-kode: id, name og size i byte.

string | null

Skrivebeskyttet. Visningsnavnet til en app-QR-kode laget i dashbordet.

object | null

Skrivebeskyttet. En pdf-QR-kode med flere filer, laget i dashbordet: title, layout og files.

object | null

Skrivebeskyttet. En image-QR-kode med flere bilder, laget i dashbordet: title, layout og files.

string

Opprettelsesdato, ISO 8601.

string

Dato for siste oppdatering, ISO 8601.

Hemmeligheter og interne ID-er (password, userId, workspaceId, projectId) returneres aldri.

{
  "id": "qr_1EPcVfeHZAY2iNoVLsgW2Aqf",
  "qrType": "website",
  "title": "Landing page",
  "description": null,
  "data": "https://getqr.sh/x7Kd2p1",
  "archived": false,
  "isStatic": false,
  "shortLink": "https://getqr.sh/x7Kd2p1",
  "domain": "getqr.sh",
  "key": "x7Kd2p1",
  "keyIsCustom": false,
  "url": "https://example.com",
  "ios": null,
  "android": null,
  "scans": 128,
  "access": {
    "passwordProtected": false,
    "activeAt": null,
    "pauseAt": null,
    "scanLimit": null
  },
  "designKind": "custom",
  "design": {
    "styles": { "dotsOptions": { "type": "rounded", "color": "#1E40AF" }, … },
    "frameOptions": { "id": "card", "text": "Scan me!", … },
    "logoOptions": { "type": "suggested", "id": "logo-website-3", "scalePercent": 25 }
  },
  "file": null,
  "appName": null,
  "pdfBundle": null,
  "imageGallery": null,
  "createdAt": "2026-08-01T10:00:00.000Z",
  "updatedAt": "2026-08-01T10:00:00.000Z"
}

Vis QR-koder

GET /api/v1/qrs Returnerer QR-kodene i arbeidsområdet ditt, én side om gangen.

integer

standard:"1"

Siden som skal returneres, 1 eller høyere.

integer

standard:"100"

QR-koder per side, fra 1 til 100. En større verdi avvises.

string

Søker i tittelen på QR-koden. Søk på mer enn 2 tegn søker også i den lagrede data. For lenketyper er den lagrede data kortlenken, så det går ikke an å søke på mål-URL-er.

string

standard:"createdAt"

Feltet det sorteres etter: createdAt, updatedAt, clicks (totalt antall skanninger), lastClicked (siste skanning) eller type. type sorterer alltid synkende og ignorerer sortOrder.

string

standard:"desc"

Sorteringsretning: asc eller desc.

boolean

standard:"false"

Ta med QR-koder som er satt på pause.

boolean

standard:"false"

Returner bare QR-koder som er satt på pause. Går foran showArchived.

Boolske parametere tar strengene true eller false. Be om neste side så lenge pagination.hasMore er true. Se Paginering.

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

{
  "data": [
    {
      "id": "qr_1EPcVfeHZAY2iNoVLsgW2Aqf",
      "qrType": "website",
      "title": "Landing page",
      "shortLink": "https://getqr.sh/x7Kd2p1",
      "url": "https://example.com",
      "scans": 128,
      "…": "…"
    }
  ],
  "pagination": { "page": 1, "pageSize": 100, "total": 1, "hasMore": false }
}

Opprett en QR-kode

POST /api/v1/qrs Oppretter en QR-kode og kortlenken samtidig. Svarer 201 Created med den nye QR-koden.

string

Ditt eget token for nye forsøk. Gjentar du forespørselen med samme nøkkel innen 24 timer, returneres det opprinnelige svaret i stedet for at det opprettes en ny QR-kode. Se Nye forsøk og duplikater.

string

påkrevd

Hva QR-koden koder. Den bestemmer også formatet data må ha. En av website, pdf, image, video, whatsapp, social, wifi, app, feedback, vcard, sms, payment, location, multilink, email, event.

string

påkrevd

Typens payload, kontrollert mot qrType. En tom streng hopper over kontrollen. Formatet for hver type står i QR-kodedata per type.

object

Kortlenken som QR-koden løses gjennom. Valgfritt: utelates den, følger link.url verdien i data.

Vis properties

string

Målet kortlenken videresender til. Utelates eller er den tom, er standard data. Når begge sendes og er ulike, vinner link.url. vcard-, social-, multilink- og event-QR-koder peker alltid mot den hostede siden sin, og pdf-, image- og video-QR-koder med en fileId mot filen. Godtatte skjemaer: http:, https:, wifi:, mailto:, sms:, begin:.

string

Domenet til kortlenken. Det må være et aktivt domene i arbeidsområdet ditt: et annet domene gir 403, og et domene som ikke er aktivt ennå, gir 422. Standard er arbeidsområdets standarddomene.

string

Slugen til kortlenken, 3 til 15 tegn, lagret med små bokstaver. En slug som ikke er tillatt, gir 422, og en som er tatt, gir 409. En tilfeldig slug på 7 tegn genereres når den utelates.

string | null

Mål-URL for besøkende på iOS, for app-QR-koder.

string | null

Mål-URL for besøkende på Android, for app-QR-koder.

string | null

Tittel for lenkeforhåndsvisning (og:title), lagret på kortlenken. Ikke det samme som QR-kodens egen title. Ingenting viser den ennå.

string | null

Beskrivelse for lenkeforhåndsvisning (og:description), lagret på kortlenken. Ingenting viser den ennå.

—

Ikke tilgjengelig i dette API-et: sender du en av dem, får du 422. Bruk access.pauseAt for å stoppe QR-koden på et bestemt tidspunkt.

string

Navnet på QR-koden, som vises i dashbordet. Mellomrom i starten og slutten fjernes, 1 til 40 tegn. Utelates den, får QR-koden ingen tittel.

string

Fritt notat om QR-koden. Opptil 280 tegn.

string

Filen til en pdf-, image- eller video-QR-kode, lastet opp med tilsvarende target. For vcard, social og multilink et valgfritt profilbilde lastet opp med target logo. event godtar den også, men siden leser forsidebildet fra data.fileId. Andre typer gir 422. Last først opp filen med Filer. Se Filer i QR-koder.

string

Mal der designet brukes på den nye QR-koden. Designfelt du sender, flettes oppå det. En mal med Branded design eller AI design gir 422 (art_template_unsupported). En ukjent mal, eller en fra et annet arbeidsområde, gir 404.

object

Former og farger på prikker og hjørner. Se Tilpasning.

object

Rammen rundt QR-koden og teksten for handlingsoppfordringen. Se Tilpasning.

object

Logo i midten: en foreslått logo eller din egen fil lastet opp med target logo. En ukjent fil, en ufullført opplasting eller en fil fra et annet target avvises. Se Tilpasning.

object

Tidsplan, skannegrense og passordbeskyttelse. Se Tilgangsregler.

Vis properties

string | null

Planlagt start, ISO 8601.

string | null

Planlagt slutt, ISO 8601.

integer | null

Maksimalt antall skanninger, et positivt heltall.

string | null

Passordet besøkende må skrive inn. Når du sender det, slås beskyttelsen på.

boolean

Slår beskyttelsen av eller på igjen og beholder det lagrede passordet.

boolean

Om QR-koden er satt på pause. true oppretter den på pause: skanninger viser pausesiden i stedet for målet.

Ukjente felt forkastes uten feil. Se Ikke støttet via API-et.

curl -X POST "https://getqr.com/api/v1/qrs" \
  -H "Authorization: Bearer $GETQR_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: landing-page-2026-08" \
  -d '{
    "qrType": "website",
    "data": "https://example.com",
    "title": "Landing page",
    "access": { "scanLimit": 500 }
  }'

{
  "id": "qr_1EPcVfeHZAY2iNoVLsgW2Aqf",
  "qrType": "website",
  "title": "Landing page",
  "data": "https://getqr.sh/x7Kd2p1",
  "shortLink": "https://getqr.sh/x7Kd2p1",
  "url": "https://example.com",
  "scans": 0,
  "access": { "passwordProtected": false, "activeAt": null, "pauseAt": null, "scanLimit": 500 },
  "…": "…"
}

Nye forsøk og duplikater

Med nøkkel. Med en Idempotency-Key-header spilles svaret av på nytt i 24 timer.
Uten nøkkel. En identisk body som sendes innen 30 sekunder, behandles som et duplikat.
Gjentatte svar. Et gjentatt svar returnerer det lagrede svaret med x-idempotent-replay: true. En ny QR-kode returnerer false.
Pågående. En ny forespørsel mens den første fortsatt kjører, får 409 conflict.
Feil. En mislykket oppretting frigjør nøkkelen med en gang, så du kan prøve igjen med samme nøkkel.
Etter beste evne. Hvis beskyttelsen ikke er tilgjengelig, går opprettinger gjennom uten beskyttelse.

Se også Idempotens.

Hent en QR-kode

GET /api/v1/qrs/{qrId} Returnerer en QR-kode med kortlenke, tilgangsregler, design og, for filbaserte typer, filen.

string

påkrevd

ID-en til QR-koden, fra svaret på listen eller opprettelsen.

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

Svaret er hele QR-kodeobjektet.

Oppdater en QR-kode

PATCH /api/v1/qrs/{qrId} Endrer innhold, mål, design eller tilgangsregler for en QR-kode. Send bare feltene du vil endre. Svarer med den oppdaterte QR-koden.

string

påkrevd

ID-en til QR-koden.

Body tar de samme feltene som Opprett en QR-kode, alle valgfrie, med disse forskjellene:

templateId. Godtas ikke.
link. Delvis. Det nåværende målet beholdes når du utelater link.url. link.domain og link.key gir 422: kortlenken er det den trykte koden koder, så opprett en ny QR-kode for å bruke en annen.
data. Kontrolleres mot den resulterende typen bare når data eller qrType endres. Bytte av qrType uten passende data avvises. Se Bytte type.
Design. styles, frameOptions og logoOptions flettes inn i det lagrede designet, så et delvis objekt endrer bare det det nevner. Velger du en annen logo, erstattes den, men størrelsen beholdes.
access. Hver nøkkel brukes når den finnes. null fjerner en regel. Tilgangsregler hører hjemme under access: sender du dem under link, får du 422.
archived. Setter QR-koden og kortlenken på pause eller reaktiverer dem samlet, akkurat som Pause og Reaktiver.

curl -X PATCH "https://getqr.com/api/v1/qrs/qr_1EPcVfeHZAY2iNoVLsgW2Aqf" \
  -H "Authorization: Bearer $GETQR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Autumn campaign",
    "access": { "password": "s3cr3t", "passwordProtected": true }
  }'

{
  "id": "qr_1EPcVfeHZAY2iNoVLsgW2Aqf",
  "title": "Autumn campaign",
  "access": { "passwordProtected": true, "activeAt": null, "pauseAt": null, "scanLimit": null },
  "…": "…"
}

Hva du kan endre etter trykk for hver type, står i QR-kodedata per type.

Angi pausestatus

PUT /api/v1/qrs/{qrId} Angir pausestatusen direkte. Pause og Reaktiver gjør det samme og er tydeligere å lese.

string

påkrevd

ID-en til QR-koden.

boolean

påkrevd

true for å sette QR-koden på pause, false for å reaktivere den.

curl -X PUT "https://getqr.com/api/v1/qrs/qr_1EPcVfeHZAY2iNoVLsgW2Aqf" \
  -H "Authorization: Bearer $GETQR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "archived": true }'

{
  "id": "qr_1EPcVfeHZAY2iNoVLsgW2Aqf",
  "archived": true,
  "…": "…"
}

Sett en QR-kode på pause

POST /api/v1/qrs/{qrId}/pause Hindrer QR-koden i å løses til målet: skanninger viser pausesiden i stedet. Den trykte koden og kortlenken forblir gyldige. Ingen body.

string

påkrevd

ID-en til QR-koden.

curl -X POST "https://getqr.com/api/v1/qrs/qr_1EPcVfeHZAY2iNoVLsgW2Aqf/pause" \
  -H "Authorization: Bearer $GETQR_API_KEY"

{
  "id": "qr_1EPcVfeHZAY2iNoVLsgW2Aqf",
  "archived": true,
  "…": "…"
}

Reaktiver en QR-kode

POST /api/v1/qrs/{qrId}/activate Får en QR-kode som er satt på pause, til å løses til målet igjen. Eventuelle tidsplaner og skannegrenser gjelder fortsatt. Ingen body.

string

påkrevd

ID-en til QR-koden.

curl -X POST "https://getqr.com/api/v1/qrs/qr_1EPcVfeHZAY2iNoVLsgW2Aqf/activate" \
  -H "Authorization: Bearer $GETQR_API_KEY"

{
  "id": "qr_1EPcVfeHZAY2iNoVLsgW2Aqf",
  "archived": false,
  "…": "…"
}

Dupliser en QR-kode

POST /api/v1/qrs/{qrId}/duplicate Oppretter en kopi med samme innhold og design. Ingen body. Svarer 201 Created med den nye QR-koden.

string

påkrevd

ID-en til QR-koden som skal kopieres.

Kortlenke. Kopien får sin egen kortlenke, med en tilfeldig slug på arbeidsområdets standarddomene, ikke kildens domene. Skanningene telles separat.
Tittel. Tittelen får suffikset (Copy). Resultatet holder seg innenfor 40 tegn: en lang tittel kortes ned først. En QR-kode uten tittel forblir uten tittel.
Kopieres ikke. Tilgangsregler (passord, tidsplan, skannegrense) og pausestatus. Kopien er alltid aktiv.
Filer. PDF- og bildefiler, også filer i pakker og gallerier, kopieres, så kopien eier dem. Videofiler og designfiler, som logoer, deles med kilden.

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

{
  "id": "qr_7Hk2PqWmX9cTnV4sLbR8YdZe",
  "title": "Landing page (Copy)",
  "shortLink": "https://getqr.sh/p2Wq9dL",
  "url": "https://example.com",
  "archived": false,
  "scans": 0,
  "…": "…"
}

Slett en QR-kode

DELETE /api/v1/qrs/{qrId} Sletter QR-koden og kortlenken. Svarer med ID-en til den slettede koden.

Sletting er permanent. Den trykte koden og kortlenken slutter å fungere, og skannehistorikken er ikke lenger tilgjengelig. Sett QR-koden på pause i stedet hvis du kanskje trenger den igjen.

string

påkrevd

ID-en til QR-koden.

string

ID-en til den slettede QR-koden.

boolean

Alltid true.

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

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

Last ned et QR-kodebilde

GET /api/v1/qrs/{qrId}/download Gjengir QR-koden med designet og returnerer filen.

string

påkrevd

ID-en til QR-koden som skal gjengis, fra svaret på listen eller opprettelsen.

string

standard:"jpg"

Utdataformat: jpg, png, svg, pdf (en A4-side) eller eps. Et Branded design eller AI design kan bare lastes ned som jpg, png eller pdf.

integer

standard:"1024"

Bildestørrelse i piksler: 1024, 2048 eller 4096. svg og pdf ignorerer den. Et Branded design eller AI design kan bare lastes ned i 1024.

`format`	`Content-Type`	Filnavn
`jpg`	`image/jpeg`	`<title>-<resolution>px.jpg`
`png`	`image/png`	`<title>-<resolution>px.png`
`svg`	`image/svg+xml`	`<title>.svg`
`pdf`	`application/pdf`	`<title>.pdf`
`eps`	`application/postscript`	`<title>-<resolution>px.eps`

Body. Svarets body er filen. Det foreslåtte filnavnet står i Content-Disposition-headeren og bygges fra tittelen, eller qr-code for en QR-kode uten tittel.
Bufring. Svarene har en ETag og Cache-Control: private, max-age=3600, must-revalidate. Send ETag tilbake i If-None-Match for å få 304 Not Modified når QR-koden ikke er endret.
Feil. Et format eller en oppløsning som ikke støttes, gir 400 bad_request. Feilmeldingen oppgir årsaken: qr_download_invalid_format, qr_download_invalid_resolution, qr_download_art_format_unsupported eller qr_download_art_resolution_unsupported.

curl "https://getqr.com/api/v1/qrs/qr_1EPcVfeHZAY2iNoVLsgW2Aqf/download?format=png&resolution=1024" \
  -H "Authorization: Bearer $GETQR_API_KEY" \
  --output qr-code.png

HTTP/1.1 200 OK
Content-Type: image/png
Content-Disposition: attachment; filename="landing-page-1024px.png"
ETag: "9f2c0e1b5a7d43c8b016e2f4a9d5c3718be40f92"
Cache-Control: private, max-age=3600, must-revalidate

<binary image data>

Tilgangsregler

Send et access-objekt ved oppretting eller oppdatering for å planlegge start og slutt, begrense antall skanninger eller kreve passord. Utelatte regler forblir uendret, og null fjerner en regel. Hele virkemåten, med eksempler, står i Tilgangsregler.

Designobjekter

styles, frameOptions og logoOptions angir former på prikker og hjørner, farger, ramme og logo. De fungerer likt for QR-koder, maler og masseopprettelser. Ukjente former, rammer eller logoer avvises. Alle godtatte verdier og et fullstendig eksempel står i Tilpasning.

Vanlige problemer

422 når jeg angir passord, tidsplan eller skannegrense

Send regelen under access, ikke under link.

422 når jeg endrer link.domain eller link.key

Kortlenken kan ikke endres etter oppretting, fordi den trykte koden koder den. Opprett en ny QR-kode i stedet.

422 "Expected … for qrType"

data samsvarer ikke med formatet for qrType. Sjekk typen i QR-kodedata per type.

409 conflict når jeg oppretter en QR-kode

En identisk oppretting kjører fortsatt, eller link.key er tatt. Prøv igjen når den første forespørselen er ferdig. Med en Idempotency-Key returnerer det nye forsøket den opprinnelige QR-koden.

Nedlastingen er JPEG, ikke PNG

Parameterne er format og resolution, og format har standardverdien jpg. Send format=png.

404 for en QR-kode jeg ser i dashbordet

Hver forespørsel kjøres i arbeidsområdet til API-nøkkelen din. Sjekk at QR-koden tilhører det. Se Autentisering.

QR-kodedata per type

Tilpasning

Tilgangsregler

​QR-kodeobjektet

​Vis QR-koder

​Opprett en QR-kode

​Nye forsøk og duplikater

​Hent en QR-kode

​Oppdater en QR-kode

​Angi pausestatus

​Sett en QR-kode på pause

​Reaktiver en QR-kode

​Dupliser en QR-kode

​Slett en QR-kode

​Last ned et QR-kodebilde

​Tilgangsregler

​Designobjekter

​Vanlige problemer

​Neste steg

QR-kodedata per type

Tilpasning

Tilgangsregler

Analyse

QR-kodeobjektet

Vis QR-koder

Opprett en QR-kode

Nye forsøk og duplikater

Hent en QR-kode

Oppdater en QR-kode

Angi pausestatus

Sett en QR-kode på pause

Reaktiver en QR-kode

Dupliser en QR-kode

Slett en QR-kode

Last ned et QR-kodebilde

Tilgangsregler

Designobjekter

Vanlige problemer

Neste steg