Barcodes

Create barcodes across 34 symbologies, with color, size, and label options.

Supported types

Pass type as one of these symbology keys. value must match the rules for that type.

  • C32
  • C39
  • C39+
  • C39E
  • C39E+
  • C93
  • S25
  • S25+
  • I25
  • I25+
  • ITF14
  • C128
  • C128A
  • C128B
  • C128C
  • EAN2
  • EAN5
  • EAN8
  • EAN13
  • UPCA
  • UPCE
  • MSI
  • MSI+
  • POSTNET
  • PLANET
  • TELEPENALPHA
  • TELEPENNUMERIC
  • RMS4CC
  • KIX
  • IMB
  • CODABAR
  • CODE11
  • PHARMA
  • PHARMA2T
POST/api/v1/barcodes
Create barcode

Send JSON with name, type, and value. type is a symbology key such as C128 or EAN13. Colors, width_scale, height, and display_text control the rendered image.

NameTypeRequiredDefaultDescription
namestringYesLabel saved on the resource.
typestringYesC128Symbology key such as C128, EAN13, or UPCA.
valuestringYesData encoded in the barcode. Must be valid for the chosen type.
project_idintegerNoProject to attach the resource to.
is_bulkbooleanNofalseIf true, one barcode is created per line in value.
foreground_colorstringNo#000000Module color as HEX.
background_colorstringNo#ffffffBackground HEX color. Keep it lighter than the modules.
width_scaleintegerNo2Bar width multiplier, 1–10.
heightintegerNo30Bar height in pixels, 30–1000.
display_textbooleanNofalseIf true, the value is printed under the bars.

Request example

curl -X POST 'https://forqrcode.com/api/v1/barcodes' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "Product SKU",
  "type": "C128",
  "value": "FORQR-1001",
  "foreground_color": "#17191c",
  "background_color": "#ffffff",
  "width_scale": 2,
  "height": 80,
  "display_text": true
}'

More examples

EAN-13

curl -X POST 'https://forqrcode.com/api/v1/barcodes' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "Retail EAN-13",
  "type": "EAN13",
  "value": "5901234123457",
  "height": 70,
  "display_text": true
}'

Response example

{
  "data": {
    "id": 1,
    "type": "C128",
    "name": "Product SKU",
    "value": "FORQR-1001",
    "barcode": "https://…/barcodes/…/barcode.svg"
  }
}
GET/api/v1/barcodes
List barcode
NameTypeRequiredDescription
pageintegerNoPage number (default 1)
results_per_pageintegerNoItems per page (default 25, max 100)
searchstringNoSearch term
search_bystringNoColumn to search
order_bystringNoSort column
order_typestringNoasc or desc
datetime_startstringNoISO datetime filter start
datetime_endstringNoISO datetime filter end
curl -X GET 'https://forqrcode.com/api/v1/barcodes' \
  -H 'Authorization: Bearer YOUR_API_KEY'
GET/api/v1/barcodes/{id}
Read one barcode
NameTypeRequiredDescription
idintegerYes
curl -X GET 'https://forqrcode.com/api/v1/barcodes/{id}' \
  -H 'Authorization: Bearer YOUR_API_KEY'
PATCH/api/v1/barcodes/{id}
Update barcode
NameTypeRequiredDefaultDescription
idintegerYes
namestringNoLabel saved on the resource.
typestringNoC128Symbology key such as C128, EAN13, or UPCA.
valuestringNoData encoded in the barcode. Must be valid for the chosen type.
project_idintegerNoProject to attach the resource to.
is_bulkbooleanNofalseIf true, one barcode is created per line in value.
foreground_colorstringNo#000000Module color as HEX.
background_colorstringNo#ffffffBackground HEX color. Keep it lighter than the modules.
width_scaleintegerNo2Bar width multiplier, 1–10.
heightintegerNo30Bar height in pixels, 30–1000.
display_textbooleanNofalseIf true, the value is printed under the bars.

Request example

curl -X PATCH 'https://forqrcode.com/api/v1/barcodes/{id}' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "value": "FORQR-2002",
  "height": 90
}'
DELETE/api/v1/barcodes/{id}
Delete barcode
NameTypeRequiredDescription
idintegerYes
curl -X DELETE 'https://forqrcode.com/api/v1/barcodes/{id}' \
  -H 'Authorization: Bearer YOUR_API_KEY'

Parameter names and JSON examples are shown in English. Replace YOUR_API_KEY with a key from your account.