Barcodes

Retrieve all

GET https://scan.aleya.ma/api/barcodes/
curl --request GET \
--url 'https://scan.aleya.ma/api/barcodes/' \
--header 'Authorization: Bearer {api_key}' \
Parameters Details Description
page Optional Integer The page number that you want results from. Defaults to 1.
results_per_page Optional Integer How many results you want per page. Allowed values are: 10 , 25 , 50 , 100 , 250 , 500 , 1000. Defaults to 25.
{ "data": [ { "id": 1, "type": "C32", "name": "Example name", "value": "123456", "barcode": "https://scan.aleya.ma/uploads/barcode/example.svg", "settings": { "foreground_color": "#000000", "width_scale": 2, "height": 50, }, "embedded_data": "123456", "last_datetime": null, "datetime": "2026-02-03 09:19:46" }, ], "meta": { "page": 1, "results_per_page": 25, "total": 1, "total_pages": 1 }, "links": { "first": "https://scan.aleya.ma/api/barcodes?&page=1", "last": "https://scan.aleya.ma/api/barcodes?&page=1", "next": null, "prev": null, "self": "https://scan.aleya.ma/api/barcodes?&page=1" } }

Retrieve one

GET https://scan.aleya.ma/api/barcodes/{barcode_id}
curl --request GET \
--url 'https://scan.aleya.ma/api/barcodes/{barcode_id}' \
--header 'Authorization: Bearer {api_key}' \
{ "data": { "id": 1, "type": "C32", "name": "Example name", "value": "123456", "barcode": "https://scan.aleya.ma/uploads/barcode/example.svg", "settings": { "foreground_color": "#000000", "width_scale": 2, "height": 50, }, "embedded_data": "123456", "last_datetime": null, "datetime": "2026-02-03 09:19:46" } }

Create

POST https://scan.aleya.ma/api/barcodes
Parameters Details Description
project_id Optional Integer -
name Required String -
type Required String Allowed values:
is_bulk Optional Boolean
value Required String -
foreground_color Optional String -
width_scale Optional Integer 1-10
height Optional Integer 30-1000
Parameters Details Description
curl --request POST \
--url 'https://scan.aleya.ma/api/barcodes' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=New York' \
--form 'type=text' \
--form 'text=Hello!' \
{ "data": { "id": 1 } }

Update

POST https://scan.aleya.ma/api/barcodes/{barcode_id}
Parameters Details Description
project_id Optional String -
name Optional String -
type Optional String Allowed values:
value Required String -
foreground_color Optional String -
width_scale Optional Integer 1-10
height Optional Integer 30-1000
curl --request POST \
--url 'https://scan.aleya.ma/api/barcodes/{barcode_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Las Vegas' \
{ "data": { "id": 1 } }

Delete

DELETE https://scan.aleya.ma/api/barcodes/{barcode_id}
curl --request DELETE \
--url 'https://scan.aleya.ma/api/barcodes/{barcode_id}' \
--header 'Authorization: Bearer {api_key}' \