QRdx
HelpGuidesDevelopersReact librarySelf-hosting

Save a barcode

Saves a static barcode to the workspace, listed under Barcodes in the dashboard.

The value is checked against the format's rules first: a retail number one digit short gets its check digit, a wrong one is a 400. Options left out use the format's defaults. Every plan saves barcodes; past the plan's limit (1,000 on Free, not counting the trash) it's 402 LIMIT_REACHED.

Scope: codes:write, for API keys and OAuth tokens alike.

POST
/barcodes

Authorization

headerAuthorizationBearer <qrdx_ followed by 40 letters and digits>

An API key, sent as Authorization: Bearer qrdx_…. Create one in Settings → API keys & apps: it is shown once. A key acts on the workspace it was created in as its creator, with their current role there, and only within its scopes, the same scopes as OAuth (each operation names the one it needs). API keys.

Request Body

application/json
  1. body
title?|

A name to find it by, up to 100 characters (default: none; lists show the value)

format*string

The symbology, as GET /barcode takes it: ean13, ean8, upca, upce, code128, code39, itf14, gs1-128, datamatrix, pdf417 or aztec

Value in"ean13""ean8""upca""upce""code128""code39""itf14""gs1-128""datamatrix""pdf417""aztec"
value*string

The number or text to encode, checked against the format's rules. Retail numbers can leave the check digit off and it's added.

Length1 <= length <= 1000
options?

How it's drawn; anything left out uses the format's defaults (black on white, the minimum quiet zone, scale 4)

folderId?|

A folder of the workspace by id (the codes' folders); null for none

Response Body

Saved

application/json
  1. response
data*

A saved barcode

curl -X POST 'https://api.qrdx.dev/v1/barcodes' \  -H 'Content-Type: application/json' \  -d '{  "format": "ean13",  "value": "590123412345",  "title": "Spring box"}'
Example Response
{  "data": {    "id": "cm5barcode0spring0box0001",    "title": "Spring box",    "format": "ean13",    "formatLabel": "EAN-13",    "value": "5901234123457",    "options": {      "foreground": "#000000",      "background": "#ffffff",      "showText": true,      "barHeightMm": 23,      "quietZone": 11,      "scale": 4,      "rotation": 0    },    "folderId": null,    "imageUrl": "https://qrdx.dev/api/v1/barcode?format=ean13&data=5901234123457",    "createdAt": "2026-01-05T09:30:00.000Z",    "updatedAt": "2026-01-05T09:30:00.000Z",    "deletedAt": null,    "organizationId": null  }}

Last updated on