Manage your codes from your own system.
Create hundreds of QR codes in one request, update their destinations, pull scan reports into your own dashboard. REST, JSON and an API key is all it takes.
Draft — the endpoints will be settled during development. This page shows the proposed structure; there is no live API yet. Addresses, field names, limits and response formats may change.
- Base URL
https://api.oqur.io/v1- Format
- JSON, UTF-8, HTTPS
- Authentication
- Bearer API key
- Plans
- Business and Enterprise
Getting started
The oqur API lets you do from your own software what you do in the panel: bulk QR creation, destination updates, print file downloads and scan reports. Every request goes over HTTPS with a JSON body.
Create a key
Create a key in the API keys section of the Settings menu in the panel and pick its scopes. When the API is ready it will open on the Business and Enterprise plans.
Send your first request
The sample beside this lists the first code on your account. If the response is 200, everything is ready.
Watch the limits
Your remaining requests are in the headers of every response. The details are in the Rate limits section.
Rules
| Topic | Format | Description |
|---|---|---|
| Date and time | ISO 8601 |
Always returned in UTC: 2026-09-30T09:12:44Z. In reports you can pick the time zone you want. |
| IDs | string |
Prefixed text: QR codes start with qr_, folders with fld_, requests with req_. |
| Pagination | integer |
With page and per_page. At most 100 records per page. |
| Version | v1 |
The version in the address. Backwards-incompatible changes come only with a new version. |
curl "https://api.oqur.io/v1/qr-codes?per_page=1" \
-H "Authorization: Bearer $OQUR_API_KEY" \
-H "Accept: application/json"
<?php
// composer require guzzlehttp/guzzle
use GuzzleHttp\Client;
$oqur = new Client([
'base_uri' => 'https://api.oqur.io/v1/',
'headers' => [
'Authorization' => 'Bearer ' . getenv('OQUR_API_KEY'),
'Accept' => 'application/json',
],
]);
$res = $oqur->get('qr-codes', ['query' => ['per_page' => 1]]);
$body = json_decode($res->getBody(), true);
// Node 18+ or other non-browser runtimes
const oqur = (path, init = {}) =>
fetch(`https://api.oqur.io/v1${path}`, {
...init,
headers: {
Authorization: `Bearer ${process.env.OQUR_API_KEY}`,
'Content-Type': 'application/json',
Accept: 'application/json',
...init.headers,
},
}).then((r) => r.json());
const body = await oqur('/qr-codes?per_page=1');
Response 200 SAMPLE
{
"data": [
{
"id": "qr_7Kq2mX",
"type": "menu",
"name": "Kafe Rıhtım · Table card",
"status": "active",
"dynamic": true,
"short_url": "https://oqur.io/d/7Kq2xP",
"created_at": "2026-09-12T08:30:00Z"
}
],
"meta": { "page": 1, "per_page": 1, "total": 42 }
}
Authentication
Add your API key to every request in the Authorization header. Requests without a key or with an invalid key return 401; keys without enough permission return 403.
- Use the key only on the server side; do not embed it in a browser or a mobile app.
- Create a separate key for each integration. If one leaks, you revoke only that one.
- Give a key only the scopes it needs:
qr:read,qr:write,analytics:read,folders:write.
Headers
| Header | Type | Description |
|---|---|---|
Authorizationrequired |
string |
Bearer followed by your API key. |
Content-Type |
string |
application/json on requests with a body. |
Accept |
string |
application/json. |
Idempotency-Key |
string |
A unique value for safely retrying create requests. A request with the same key within 24 hours returns the first response. |
Request headersSAMPLE
Authorization: Bearer oqur_live_8f3kQ2…
Content-Type: application/json
Accept: application/json
Response 401 SAMPLE
{
"error": {
"code": "unauthenticated",
"message": "The API key is missing or invalid.",
"request_id": "req_5nT2pW"
}
}
Rate limits
Each API key can make 60 requests a minute; on the Enterprise plan the limit is set to your needs. Bulk endpoints handle 100 items in one request, so you can create or edit up to 6,000 codes a minute.
Response headers
| Header | Type | Description |
|---|---|---|
X-RateLimit-Limit |
integer |
Your total requests per minute. |
X-RateLimit-Remaining |
integer |
Requests left for this minute. |
X-RateLimit-Reset |
integer |
When your allowance resets, as a Unix timestamp. |
Retry-After |
integer |
Only on a 429 response: how many seconds to wait. |
When you get a 429, wait for Retry-After and try again. With repeated errors, doubling the wait on each try is the safest way.
Response 429 SAMPLE
HTTP/1.1 429 Too Many Requests
X-RateLimit-Limit: 60
X-RateLimit-Remaining: 0
X-RateLimit-Reset: 1790759580
Retry-After: 18
{
"error": {
"code": "rate_limited",
"message": "You used up your requests for this minute. Try again in 18 seconds.",
"request_id": "req_9kP1sV"
}
}
QR codes
Creating and editing codes and producing print files. Changing a dynamic code’s destination does not change its short link: the printed code stays the same.
Bulk create
POST
/qr-codes/bulk
Creates up to 100 QR codes in one request. Each item is validated on its own; if any item is invalid, none is created and the errors come back in item order.
Authentication: ApiKeyAuth (Bearer)Scope: qr:write
Headers
| Header | Type | Description |
|---|---|---|
Idempotency-Key |
string |
A unique value for safely sending the request again. |
Request body
| Field | Type | Description |
|---|---|---|
itemsrequired |
array |
The codes to create. At least 1, at most 100 items. |
items[].typerequired |
string |
QR type: one of the 24 types such as url, pdf, menu, vcard-plus, wifi. |
items[].targetrequired |
object |
A destination that depends on the type. The url field for the url type, the file_url field for the pdf type. |
items[].name |
string |
The name shown in the panel. At most 120 characters. |
items[].folder_id |
string |
The folder to add the code to. |
items[].design |
object |
Colour, pattern, corners, logo and frame. If left empty, your account’s default template is used. |
Types on the Q5 line (wifi, text, vcard, email, sms, whatsapp) are created static and do not count against your dynamic code quota.
Status codes
- 201 The codes were created.
- 401 The API key is missing or invalid.
- 403 Your plan does not allow the API or this many dynamic codes.
- 422 One or more items are invalid; the details are in the details array.
- 429 You hit the rate limit; wait for Retry-After.
curl -X POST https://api.oqur.io/v1/qr-codes/bulk \
-H "Authorization: Bearer $OQUR_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: campaign-september-01" \
-d '{
"items": [
{
"type": "url",
"name": "Poster · Kadıköy",
"target": { "url": "https://cafename.com/campaign" },
"folder_id": "fld_91xQ"
},
{
"type": "pdf",
"name": "Katalog 2026",
"target": { "file_url": "https://kafeadi.com/katalog.pdf" }
}
]
}'
<?php
// $oqur: the client from Getting started
$res = $oqur->post('qr-codes/bulk', [
'headers' => ['Idempotency-Key' => 'campaign-september-01'],
'json' => [
'items' => [
[
'type' => 'url',
'name' => 'Poster · Kadıköy',
'target' => ['url' => 'https://cafename.com/campaign'],
'folder_id' => 'fld_91xQ',
],
[
'type' => 'pdf',
'name' => 'Katalog 2026',
'target' => ['file_url' => 'https://kafeadi.com/katalog.pdf'],
],
],
],
]);
// oqur(): the helper from Getting started
const { data } = await oqur('/qr-codes/bulk', {
method: 'POST',
headers: { 'Idempotency-Key': 'campaign-september-01' },
body: JSON.stringify({
items: [
{
type: 'url',
name: 'Poster · Kadıköy',
target: { url: 'https://cafename.com/campaign' },
folder_id: 'fld_91xQ',
},
{
type: 'pdf',
name: 'Katalog 2026',
target: { file_url: 'https://kafeadi.com/katalog.pdf' },
},
],
}),
});
Response 201 SAMPLE
{
"data": [
{
"id": "qr_7Kq2mX",
"type": "url",
"name": "Poster · Kadıköy",
"status": "active",
"dynamic": true,
"short_url": "https://oqur.io/d/7Kq2xP",
"folder_id": "fld_91xQ",
"created_at": "2026-09-30T09:12:44Z"
},
{
"id": "qr_8Lr3nY",
"type": "pdf",
"name": "Katalog 2026",
"status": "active",
"dynamic": true,
"short_url": "https://oqur.io/d/8Lr3nQ",
"folder_id": null,
"created_at": "2026-09-30T09:12:44Z"
}
],
"meta": { "created": 2 }
}
Bulk update
PATCH
/qr-codes/bulk
Updates up to 100 codes in one request. Only the fields you send change; the short link and the printed code stay the same.
Authentication: ApiKeyAuth (Bearer)Scope: qr:write
Request body
| Field | Type | Description |
|---|---|---|
itemsrequired |
array |
The codes to update. At least 1, at most 100 items. |
items[].idrequired |
string |
The code’s ID. |
items[].target |
object |
The new destination. The next scans go to it right away. |
items[].status |
string |
active or paused. People scanning a paused code see a plain “temporarily closed” page. |
items[].name |
string |
The new name. |
items[].folder_id |
string |
The folder to move it to; null to take it out of its folder. |
items[].design |
object |
Design fields. The sub-fields you send are merged. |
Status codes
- 200 The codes were updated.
- 401 The API key is missing or invalid.
- 404 A code in the list was not found or is not yours.
- 422 An item is invalid; no code was updated.
- 429 You hit the rate limit.
curl -X PATCH https://api.oqur.io/v1/qr-codes/bulk \
-H "Authorization: Bearer $OQUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"items": [
{ "id": "qr_7Kq2mX", "target": { "url": "https://kafeadi.com/ekim" } },
{ "id": "qr_8Lr3nY", "status": "paused" }
]
}'
<?php
$res = $oqur->patch('qr-codes/bulk', [
'json' => [
'items' => [
['id' => 'qr_7Kq2mX', 'target' => ['url' => 'https://kafeadi.com/ekim']],
['id' => 'qr_8Lr3nY', 'status' => 'paused'],
],
],
]);
const { data } = await oqur('/qr-codes/bulk', {
method: 'PATCH',
body: JSON.stringify({
items: [
{ id: 'qr_7Kq2mX', target: { url: 'https://kafeadi.com/ekim' } },
{ id: 'qr_8Lr3nY', status: 'paused' },
],
}),
});
Response 200 SAMPLE
{
"data": [
{ "id": "qr_7Kq2mX", "status": "active", "updated_at": "2026-09-30T10:04:12Z" },
{ "id": "qr_8Lr3nY", "status": "paused", "updated_at": "2026-09-30T10:04:12Z" }
],
"meta": { "updated": 2 }
}
List
GET
/qr-codes
Returns the codes on your account, paginated. The default order is newest first.
Authentication: ApiKeyAuth (Bearer)Scope: qr:read
Query parameters
| Field | Type | Description |
|---|---|---|
page |
integer |
Page number. Default 1. |
per_page |
integer |
Records per page. Default 25, at most 100. |
folder_id |
string |
Only the codes in this folder. |
type |
string |
Filter by type, for example menu. |
status |
string |
draft, scheduled, active or paused. |
search |
string |
Searches the name or the short link. |
sort |
string |
created_at, name or scans_total. For descending order put a minus in front: -scans_total. |
Status codes
- 200 The list came back; with no results, data is an empty array.
- 401 The API key is missing or invalid.
- 422 An invalid filter or sort value.
curl -G https://api.oqur.io/v1/qr-codes \
-H "Authorization: Bearer $OQUR_API_KEY" \
-d folder_id=fld_91xQ \
-d status=active \
-d sort=-scans_total \
-d per_page=25
<?php
$res = $oqur->get('qr-codes', ['query' => [
'folder_id' => 'fld_91xQ',
'status' => 'active',
'sort' => '-scans_total',
'per_page' => 25,
]]);
const params = new URLSearchParams({
folder_id: 'fld_91xQ',
status: 'active',
sort: '-scans_total',
per_page: '25',
});
const { data, meta } = await oqur(`/qr-codes?${params}`);
Response 200 SAMPLE
{
"data": [
{
"id": "qr_7Kq2mX",
"type": "url",
"name": "Poster · Kadıköy",
"status": "active",
"short_url": "https://oqur.io/d/7Kq2xP",
"scans_total": 312,
"created_at": "2026-09-12T08:30:00Z"
}
],
"meta": { "page": 1, "per_page": 25, "total": 1 },
"links": { "next": null, "prev": null }
}
Get
GET
/qr-codes/{id}
Returns every field of one code: destination, design, status and total scans.
Authentication: ApiKeyAuth (Bearer)Scope: qr:read
Path parameters
| Field | Type | Description |
|---|---|---|
idrequired |
string |
The code’s ID, for example qr_7Kq2mX. |
Status codes
- 200 The code was found.
- 401 The API key is missing or invalid.
- 404 The code does not exist or is not yours.
curl https://api.oqur.io/v1/qr-codes/qr_7Kq2mX \
-H "Authorization: Bearer $OQUR_API_KEY"
<?php
$res = $oqur->get('qr-codes/qr_7Kq2mX');
$code = json_decode($res->getBody(), true)['data'];
const { data: code } = await oqur('/qr-codes/qr_7Kq2mX');
Response 200 SAMPLE
{
"data": {
"id": "qr_7Kq2mX",
"type": "url",
"name": "Poster · Kadıköy",
"status": "active",
"dynamic": true,
"short_url": "https://oqur.io/d/7Kq2xP",
"target": { "url": "https://cafename.com/campaign" },
"folder_id": "fld_91xQ",
"design": {
"foreground": "#0B1F3A",
"background": "#FFFFFF",
"dots": "rounded",
"corners": "square",
"logo_url": null,
"frame": { "style": "bottom", "text": "Beni tara" },
"error_correction": "M"
},
"scans_total": 312,
"created_at": "2026-09-12T08:30:00Z",
"updated_at": "2026-09-28T17:02:10Z"
}
}
Update
PATCH
/qr-codes/{id}
Updates one code. Changing the destination does not change the code: the printed QR stays the same, the next scans go to the new destination.
Authentication: ApiKeyAuth (Bearer)Scope: qr:write
Path parameters
| Field | Type | Description |
|---|---|---|
idrequired |
string |
The code’s ID. |
Request body
| Field | Type | Description |
|---|---|---|
target |
object |
The new destination. Cannot be changed on static codes. |
status |
string |
active or paused. |
name |
string |
The new name. |
folder_id |
string |
The folder to move it to; null to take it out of its folder. |
design |
object |
Design fields. The sub-fields you send are merged. |
Status codes
- 200 The code was updated.
- 401 The API key is missing or invalid.
- 404 The code does not exist or is not yours.
- 422 An invalid field; for example, a static code’s destination cannot be changed.
curl -X PATCH https://api.oqur.io/v1/qr-codes/qr_7Kq2mX \
-H "Authorization: Bearer $OQUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{ "target": { "url": "https://kafeadi.com/kis-menusu" } }'
<?php
$res = $oqur->patch('qr-codes/qr_7Kq2mX', [
'json' => ['target' => ['url' => 'https://kafeadi.com/kis-menusu']],
]);
const { data } = await oqur('/qr-codes/qr_7Kq2mX', {
method: 'PATCH',
body: JSON.stringify({ target: { url: 'https://kafeadi.com/kis-menusu' } }),
});
Response 200 SAMPLE
{
"data": {
"id": "qr_7Kq2mX",
"status": "active",
"short_url": "https://oqur.io/d/7Kq2xP",
"target": { "url": "https://kafeadi.com/kis-menusu" },
"updated_at": "2026-09-30T10:15:03Z"
}
}
Duplicate
POST
/qr-codes/{id}/duplicate
Copies the code with its design and destination. The copy starts with a new short link and zero scans; the fastest way to repeat the same design for branches.
Authentication: ApiKeyAuth (Bearer)Scope: qr:write
Path parameters
| Field | Type | Description |
|---|---|---|
idrequired |
string |
The ID of the code to copy. |
Request body
| Field | Type | Description |
|---|---|---|
name |
string |
The copy’s name. If left empty, “(copy)” is added to the original name. |
folder_id |
string |
The folder to add the copy to. Default: the original code’s folder. |
Status codes
- 201 The copy was created.
- 401 The API key is missing or invalid.
- 403 You reached the dynamic code limit.
- 404 The code does not exist or is not yours.
curl -X POST https://api.oqur.io/v1/qr-codes/qr_7Kq2mX/duplicate \
-H "Authorization: Bearer $OQUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{ "name": "Poster · Beşiktaş" }'
<?php
$res = $oqur->post('qr-codes/qr_7Kq2mX/duplicate', [
'json' => ['name' => 'Poster · Beşiktaş'],
]);
const { data: copy } = await oqur('/qr-codes/qr_7Kq2mX/duplicate', {
method: 'POST',
body: JSON.stringify({ name: 'Poster · Beşiktaş' }),
});
Response 201 SAMPLE
{
"data": {
"id": "qr_9Ms4pZ",
"type": "url",
"name": "Poster · Beşiktaş",
"status": "active",
"short_url": "https://oqur.io/d/9Ms4pR",
"scans_total": 0,
"created_at": "2026-09-30T10:20:31Z"
}
}
Create image
POST
/qr-codes/{id}/image
Produces a print-ready image of the code and returns a short-lived download link. You can pass settings just for this image without changing the saved design.
Authentication: ApiKeyAuth (Bearer)Scope: qr:read
Path parameters
| Field | Type | Description |
|---|---|---|
idrequired |
string |
The code’s ID. |
Request body
| Field | Type | Description |
|---|---|---|
formatrequired |
string |
png, svg, pdf or eps. |
size |
integer |
For PNG, the edge length in pixels. Between 256 and 4096; default 1024. |
margin |
integer |
The quiet zone, in modules. Default 4; less is not recommended. |
design |
object |
Temporary design settings for this image only. |
The download link is valid for 1 hour. If you want to keep the file on your own server, use the Get image endpoint.
Status codes
- 200 The image is ready.
- 401 The API key is missing or invalid.
- 404 The code does not exist or is not yours.
- 422 An unsupported format or size.
curl -X POST https://api.oqur.io/v1/qr-codes/qr_7Kq2mX/image \
-H "Authorization: Bearer $OQUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{ "format": "svg", "margin": 4 }'
<?php
$res = $oqur->post('qr-codes/qr_7Kq2mX/image', [
'json' => ['format' => 'svg', 'margin' => 4],
]);
$url = json_decode($res->getBody(), true)['data']['url'];
const { data } = await oqur('/qr-codes/qr_7Kq2mX/image', {
method: 'POST',
body: JSON.stringify({ format: 'svg', margin: 4 }),
});
console.log(data.url); // valid for 1 hour
Response 200 SAMPLE
{
"data": {
"format": "svg",
"url": "https://cdn.oqur.io/r/qr_7Kq2mX.svg?sig=Vb8f2…",
"expires_at": "2026-09-30T11:12:44Z"
}
}
Get image
GET
/qr-codes/{id}/image.{format}
Returns the image directly as a file. The response is the file itself, not JSON; good for keeping on your server or adding to a print workflow.
Authentication: ApiKeyAuth (Bearer)Scope: qr:read
Path parameters
| Field | Type | Description |
|---|---|---|
idrequired |
string |
The code’s ID. |
formatrequired |
string |
png, svg, pdf or eps. |
Query parameters
| Field | Type | Description |
|---|---|---|
size |
integer |
For PNG, the edge length in pixels. Default 1024. |
margin |
integer |
The quiet zone, in modules. Default 4. |
Status codes
- 200 The file came back.
- 401 The API key is missing or invalid.
- 404 The code does not exist or is not yours.
- 422 An unsupported format or size.
curl https://api.oqur.io/v1/qr-codes/qr_7Kq2mX/image.png?size=2048 \
-H "Authorization: Bearer $OQUR_API_KEY" \
-o masa-karti.png
<?php
$oqur->get('qr-codes/qr_7Kq2mX/image.png', [
'query' => ['size' => 2048],
'sink' => __DIR__ . '/masa-karti.png',
]);
import { writeFile } from 'node:fs/promises';
const res = await fetch('https://api.oqur.io/v1/qr-codes/qr_7Kq2mX/image.png?size=2048', {
headers: { Authorization: `Bearer ${process.env.OQUR_API_KEY}` },
});
await writeFile('masa-karti.png', Buffer.from(await res.arrayBuffer()));
Response 200 SAMPLE
HTTP/1.1 200 OK
Content-Type: image/png
Content-Length: 48213
Content-Disposition: attachment; filename="qr_7Kq2mX.png"
Cache-Control: private, max-age=300
(ikili PNG verisi)
Bulk delete
DELETE
/qr-codes?ids=…
Moves up to 100 codes to the bin. Codes in the bin can be brought back from the panel within 30 days; people scanning a dynamic code in the bin see a “this code is not in use” page. If you only want to stop a code, set its status to paused.
Authentication: ApiKeyAuth (Bearer)Scope: qr:write
Query parameters
| Field | Type | Description |
|---|---|---|
idsrequired |
string |
Comma-separated code IDs, at most 100. |
Status codes
- 200 The codes were moved to the bin.
- 401 The API key is missing or invalid.
- 404 A code in the list was not found; no code was deleted.
- 422 The ID list is empty or over 100.
curl -X DELETE "https://api.oqur.io/v1/qr-codes?ids=qr_7Kq2mX,qr_8Lr3nY,qr_9Ms4pZ" \
-H "Authorization: Bearer $OQUR_API_KEY"
<?php
$res = $oqur->delete('qr-codes', ['query' => [
'ids' => implode(',', ['qr_7Kq2mX', 'qr_8Lr3nY', 'qr_9Ms4pZ']),
]]);
const ids = ['qr_7Kq2mX', 'qr_8Lr3nY', 'qr_9Ms4pZ'].join(',');
const { meta } = await oqur(`/qr-codes?ids=${ids}`, { method: 'DELETE' });
Response 200 SAMPLE
{
"meta": { "deleted": 3 }
}
Analytics
Pull scan data into your own reports. Reports contain no personal data: no IP address, device ID or exact location is returned.
Analytics report
GET
/analytics/scans
Returns the totals, the time series and the breakdown for the codes and date range you pick. Dates and times are grouped in the time zone you want.
Authentication: ApiKeyAuth (Bearer)Scope: analytics:read
Query parameters
| Field | Type | Description |
|---|---|---|
fromrequired |
date |
Start date, YYYY-MM-DD. |
torequired |
date |
End date, inclusive. The range is at most 366 days. |
qr_ids |
string |
Comma-separated code IDs. If left empty, all codes. |
timezone |
string |
An IANA time zone, for example Europe/Istanbul. Default: the workspace’s time zone. |
group_by |
string |
hour, day, week or month. Default day. |
breakdown |
string |
country, city, device, os or browser. |
Status codes
- 200 The report came back.
- 401 The API key is missing or invalid.
- 422 The date range is invalid or over 366 days.
- 429 You hit the rate limit.
curl -G https://api.oqur.io/v1/analytics/scans \
-H "Authorization: Bearer $OQUR_API_KEY" \
-d from=2026-09-01 \
-d to=2026-09-07 \
-d timezone=Europe/Istanbul \
-d group_by=day \
-d breakdown=device
<?php
$res = $oqur->get('analytics/scans', ['query' => [
'from' => '2026-09-01',
'to' => '2026-09-07',
'timezone' => 'Europe/Istanbul',
'group_by' => 'day',
'breakdown' => 'device',
]]);
const params = new URLSearchParams({
from: '2026-09-01',
to: '2026-09-07',
timezone: 'Europe/Istanbul',
group_by: 'day',
breakdown: 'device',
});
const { data: report } = await oqur(`/analytics/scans?${params}`);
Response 200 SAMPLE
{
"data": {
"range": { "from": "2026-09-01", "to": "2026-09-07", "timezone": "Europe/Istanbul" },
"totals": { "scans": 1840, "unique_scans": 1312 },
"series": [
{ "period": "2026-09-01", "scans": 212, "unique_scans": 160 },
{ "period": "2026-09-02", "scans": 247, "unique_scans": 181 }
],
"breakdown": {
"by": "device",
"items": [
{ "key": "ios", "scans": 1011 },
{ "key": "android", "scans": 783 },
{ "key": "desktop", "scans": 46 }
]
}
}
}
Folders
Group your codes by branch, campaign or customer. Everyone on the team sees every folder; their role decides what they can do.
Create folder
POST
/folders
Creates a new folder to group your codes.
Authentication: ApiKeyAuth (Bearer)Scope: folders:write
Request body
| Field | Type | Description |
|---|---|---|
namerequired |
string |
Folder name, between 1 and 80 characters. Must be unique on your account. |
Status codes
- 201 The folder was created.
- 401 The API key is missing or invalid.
- 409 A folder with this name already exists.
- 422 The name is empty or over 80 characters.
curl -X POST https://api.oqur.io/v1/folders \
-H "Authorization: Bearer $OQUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{ "name": "Kadıköy branch" }'
<?php
$res = $oqur->post('folders', ['json' => ['name' => 'Kadıköy branch']]);
const { data: folder } = await oqur('/folders', {
method: 'POST',
body: JSON.stringify({ name: 'Kadıköy branch' }),
});
Response 201 SAMPLE
{
"data": {
"id": "fld_91xQ",
"name": "Kadıköy branch",
"qr_count": 0,
"created_at": "2026-09-30T10:31:08Z"
}
}
List folders
GET
/folders
Returns the folders on your account with how many codes each holds.
Authentication: ApiKeyAuth (Bearer)Scope: qr:read
Query parameters
| Field | Type | Description |
|---|---|---|
page |
integer |
Page number. Default 1. |
per_page |
integer |
Records per page. Default 25, at most 100. |
Status codes
- 200 The list came back.
- 401 The API key is missing or invalid.
curl https://api.oqur.io/v1/folders \
-H "Authorization: Bearer $OQUR_API_KEY"
<?php
$res = $oqur->get('folders');
$folders = json_decode($res->getBody(), true)['data'];
const { data: folders } = await oqur('/folders');
Response 200 SAMPLE
{
"data": [
{ "id": "fld_91xQ", "name": "Kadıköy branch", "qr_count": 14 },
{ "id": "fld_22bR", "name": "Packaging · September", "qr_count": 120 }
],
"meta": { "page": 1, "per_page": 25, "total": 2 }
}
Error codes
Errors always come back the same way: an HTTP status code and an error object. The code field is for your software, the message field for people; the message text may change, rely on the code.
Statuses
| HTTP | code | Description |
|---|---|---|
400 |
bad_request |
The request body could not be read. Make sure the JSON is valid and check the Content-Type header. |
401 |
unauthenticated |
The API key is missing or invalid. Check the Authorization header. |
403 |
forbidden |
Your plan or key is not allowed to do this; for example, you reached the dynamic code limit. |
404 |
not_found |
The record does not exist or is not on your account. |
409 |
conflict |
A record with the same name exists, or an Idempotency-Key was reused with a different body. |
422 |
validation_failed |
A field is invalid. Which field was rejected and why is in the details array. |
429 |
rate_limited |
You hit the rate limit. Wait for Retry-After. |
500 |
server_error |
Something went wrong on our side. Try again; if it persists, write to us with the request_id. |
Response 422 SAMPLE
{
"error": {
"code": "validation_failed",
"message": "2 items failed validation.",
"details": [
{ "field": "items.0.target.url", "message": "Must be a valid web address." },
{ "field": "items.3.type", "message": "Bilinmeyen QR tipi: menu2." }
],
"request_id": "req_3hV8qL"
}
}
Something wrong?
Write to us with the request_id value; we will find your request and look into it.
Technical supportTry it in the panel first, then automate.
When the API is ready it will open on the Business and Enterprise plans. For enterprise integrations you can talk to our sales team.