QR codes

Retrieve all

Endpoint

GEThttps://toolzin.com/api/qr-codes/

Example

curl --request GET \
--url 'https://toolzin.com/api/qr-codes/' \
--header 'Authorization: Bearer {api_key}' \

Parameters	Details	Description
page	OptionalInteger	The page number that you want results from. Defaults to `1`.
results_per_page	OptionalInteger	How many results you want per page. Allowed values are: `10` , `25` , `50` , `100` , `250` , `500`. Defaults to `25`.

Response example

 { "data": [ { "id": 1, "type": "url", "name": "Example name", "qr_code": "https://toolzin.com/uploads/qr_code/example.svg", "qr_code_logo": null, "settings": { "foreground_type": "color", "foreground_color": "#000000", "background_color": "#ffffff", "custom_eyes_color": false, "qr_code_logo_size": 25, "size": 500, "margin": 0, "ecc": "L", "url": "https://example.com" }, "last_datetime": "2021-10-31 09:47:25", "datetime": "2021-10-29 16:32:25" }, ], "meta": { "page": 1, "results_per_page": 25, "total": 1, "total_pages": 1 }, "links": { "first": "https://toolzin.com/api/qr-codes?&page=1", "last": "https://toolzin.com/api/qr-codes?&page=1", "next": null, "prev": null, "self": "https://toolzin.com/api/qr-codes?&page=1" } }

Retrieve one

Endpoint

GEThttps://toolzin.com/api/qr-codes/{qr_code_id}

Example

curl --request GET \
--url 'https://toolzin.com/api/qr-codes/{qr_code_id}' \
--header 'Authorization: Bearer {api_key}' \

Response example

 { "data": { "id": 1, "type": "url", "name": "Example name", "qr_code": "https://toolzin.com/uploads/qr_code/example.svg", "qr_code_logo": null, "settings": { "foreground_type": "color", "foreground_color": "#000000", "background_color": "#ffffff", "custom_eyes_color": false, "qr_code_logo_size": 25, "size": 500, "margin": 0, "ecc": "L", "url": "https://example.com" }, "last_datetime": "2021-10-31 09:47:25", "datetime": "2021-10-29 16:32:25" } }

Parameters	Details	Description
project_id	OptionalInteger	-
name	RequiredString	-
type	RequiredString	`text` , `url` , `phone` , `sms` , `email` , `whatsapp` , `facetime` , `location` , `wifi` , `event` , `crypto` , `vcard` , `paypal`
style	OptionalString	`square`, `dot`, `round`
foreground_type	OptionalString	`color`, `gradient`
foreground_color	OptionalString	(foreground_type=color)
foreground_gradient_style	OptionalString	`verticalhorizontaldiagonalinverse_diagonalradial` (foreground_type=gradient)
foreground_gradient_one	OptionalString	(foreground_type=gradient)
foreground_gradient_two	OptionalString	(foreground_type=gradient)
background_color	OptionalString
background_color_transparency	OptionalInteger
custom_eyes_color	OptionalBoolean
eyes_inner_color	OptionalString	(custom_eyes_color=1)
eyes_outer_color	OptionalString	(custom_eyes_color=1)
qr_code_logo	OptionalFile	-
qr_code_logo_size	OptionalInteger	5-35
size	OptionalInteger	50-2000
margin	OptionalInteger	0-25
ecc	OptionalString	`L`, `M`, `Q`, `H`
text	OptionalString	(type=text)
url	OptionalString	(type=url)
phone	OptionalString	(type=phone)
sms	OptionalString	(type=sms)
sms_body	OptionalString	(type=sms)
email	OptionalString	(type=email)
email_subject	OptionalString	(type=email)
email_body	OptionalString	(type=email)
whatsapp	OptionalString	(type=whatsapp)
whatsapp_body	OptionalString	(type=whatsapp)
facetime	OptionalString	(type=facetime)
location_latitude	OptionalFloat	(type=location)
location_longitude	OptionalFloat	(type=location)
wifi_ssid	OptionalString	(type=wifi)
wifi_encryption	OptionalString	`nopass`, `WEP`, `WPA/WPA2` (type=wifi)
wifi_password	OptionalString	(type=wifi)
wifi_is_hidden	OptionalBoolean	(type=wifi)
event	OptionalString	(type=event)
event_location	OptionalString	(type=event)
event_url	OptionalString	(type=event)
event_note	OptionalString	(type=event)
event_timezone	OptionalString	(type=event)
event_start_datetime	OptionalString	(type=event)
event_end_datetime	OptionalString	(type=event)
crypto_coin	OptionalString	(type=crypto)
crypto_address	OptionalString	(type=crypto)
crypto_amount	OptionalString	(type=crypto)
vcard_first_name	OptionalString	(type=vcard)
vcard_last_name	OptionalString	(type=vcard)
vcard_company	OptionalString	(type=vcard)
vcard_phone	OptionalString	(type=vcard)
vcard_email	OptionalString	(type=vcard)
vcard_url	OptionalString	(type=vcard)
vcard_job_title	OptionalString	(type=vcard)
vcard_birthday	OptionalString	(type=vcard)
vcard_street	OptionalString	(type=vcard)
vcard_city	OptionalString	(type=vcard)
vcard_zip	OptionalString	(type=vcard)
vcard_region	OptionalString	(type=vcard)
vcard_country	OptionalString	(type=vcard)
vcard_note	OptionalString	(type=vcard)
vcard_social_label[index]	OptionalString	(type=vcard)
vcard_social_value[index]	OptionalString	(type=vcard)

curl --request POST \
--url 'https://toolzin.com/api/qr-codes' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=New York' \
--form 'type=text' \
--form 'text=Hello!' \

Response example

 { "data": { "id": 1 } }

Update

Endpoint

POSThttps://toolzin.com/api/qr-codes/{qr_code_id}

Parameters	Details	Description
project_id	OptionalString	-
name	OptionalString	-
type	OptionalString	`text` , `url` , `phone` , `sms` , `email` , `whatsapp` , `facetime` , `location` , `wifi` , `event` , `crypto` , `vcard` , `paypal`
style	OptionalString	`square`, `dot`, `round`
foreground_type	OptionalString	`color`, `gradient`
foreground_color	OptionalString	(foreground_type=color)
foreground_gradient_style	OptionalString	`verticalhorizontaldiagonalinverse_diagonalradial` (foreground_type=gradient)
foreground_gradient_one	OptionalString	(foreground_type=gradient)
foreground_gradient_two	OptionalString	(foreground_type=gradient)
background_color	OptionalString
background_color_transparency	OptionalInteger
custom_eyes_color	OptionalBoolean
eyes_inner_color	OptionalString	(custom_eyes_color=1)
eyes_outer_color	OptionalString	(custom_eyes_color=1)
qr_code_logo	OptionalFile	-
qr_code_logo_size	OptionalInteger	5-35
size	OptionalInteger	50-2000
margin	OptionalInteger	0-25
ecc	OptionalString	`L`, `M`, `Q`, `H`
text	OptionalString	(type=text)
url	OptionalString	(type=url)
phone	OptionalString	(type=phone)
sms	OptionalString	(type=sms)
sms_body	OptionalString	(type=sms)
email	OptionalString	(type=email)
email_subject	OptionalString	(type=email)
email_body	OptionalString	(type=email)
whatsapp	OptionalString	(type=whatsapp)
whatsapp_body	OptionalString	(type=whatsapp)
facetime	OptionalString	(type=facetime)
location_latitude	OptionalFloat	(type=location)
location_longitude	OptionalFloat	(type=location)
wifi_ssid	OptionalString	(type=wifi)
wifi_encryption	OptionalString	`nopass`, `WEP`, `WPA/WPA2` (type=wifi)
wifi_password	OptionalString	(type=wifi)
wifi_is_hidden	OptionalBoolean	(type=wifi)
event	OptionalString	(type=event)
event_location	OptionalString	(type=event)
event_url	OptionalString	(type=event)
event_note	OptionalString	(type=event)
event_timezone	OptionalString	(type=event)
event_start_datetime	OptionalString	(type=event)
event_end_datetime	OptionalString	(type=event)
crypto_coin	OptionalString	(type=crypto)
crypto_address	OptionalString	(type=crypto)
crypto_amount	OptionalString	(type=crypto)
vcard_first_name	OptionalString	(type=vcard)
vcard_last_name	OptionalString	(type=vcard)
vcard_company	OptionalString	(type=vcard)
vcard_phone	OptionalString	(type=vcard)
vcard_email	OptionalString	(type=vcard)
vcard_url	OptionalString	(type=vcard)
vcard_job_title	OptionalString	(type=vcard)
vcard_birthday	OptionalString	(type=vcard)
vcard_street	OptionalString	(type=vcard)
vcard_city	OptionalString	(type=vcard)
vcard_zip	OptionalString	(type=vcard)
vcard_region	OptionalString	(type=vcard)
vcard_country	OptionalString	(type=vcard)
vcard_note	OptionalString	(type=vcard)
vcard_social_label[index]	OptionalString	(type=vcard)
vcard_social_value[index]	OptionalString	(type=vcard)

Example

curl --request POST \
--url 'https://toolzin.com/api/qr-codes/{qr_code_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Las Vegas' \

Response example

 { "data": { "id": 1 } }

Delete

Endpoint

DELETEhttps://toolzin.com/api/qr-codes/{qr_code_id}

Example

curl --request DELETE \
--url 'https://toolzin.com/api/qr-codes/{qr_code_id}' \
--header 'Authorization: Bearer {api_key}' \

QR codes

Retrieve all

Retrieve one

Create

Update

Delete