Шаблони

curl "https://getqr.com/api/v1/templates?page=1&pageSize=100" \
  -H "Authorization: Bearer $GETQR_API_KEY"

{
  "data": [
    {
      "id": "qrt_8Hs2mQvKpLd4RtYw",
      "name": "Brand blue",
      "designKind": "custom",
      "design": {
        "styles": {
          "dotsOptions": { "type": "rounded", "color": "#1E40AF" },
          "backgroundOptions": { "color": "#FFFFFF" }
        },
        "frameOptions": null,
        "logoOptions": null
      },
      "createdAt": "2026-07-20T09:12:00.000Z",
      "updatedAt": "2026-07-20T09:12:00.000Z"
    }
  ],
  "pagination": { "page": 1, "pageSize": 100, "total": 1, "hasMore": false }
}

curl "https://getqr.com/api/v1/templates?page=1&pageSize=100" \
  -H "Authorization: Bearer $GETQR_API_KEY"

{
  "data": [
    {
      "id": "qrt_8Hs2mQvKpLd4RtYw",
      "name": "Brand blue",
      "designKind": "custom",
      "design": {
        "styles": {
          "dotsOptions": { "type": "rounded", "color": "#1E40AF" },
          "backgroundOptions": { "color": "#FFFFFF" }
        },
        "frameOptions": null,
        "logoOptions": null
      },
      "createdAt": "2026-07-20T09:12:00.000Z",
      "updatedAt": "2026-07-20T09:12:00.000Z"
    }
  ],
  "pagination": { "page": 1, "pageSize": 100, "total": 1, "hasMore": false }
}

API GetQR перебуває в бета-версії та доступний для окремих робочих просторів. До загального релізу деталі можуть змінитися.

Шаблон зберігає дизайн для повторного використання: styles, frameOptions і logoOptions. Він ніколи не містить вмісту чи посилання. Шаблони спільні для всіх у робочому просторі.

Метод	Шлях	Опис
`GET`	`/api/v1/templates`	Список шаблонів
`POST`	`/api/v1/templates`	Створення шаблону
`GET`	`/api/v1/templates/{templateId}`	Отримання шаблону
`PATCH`	`/api/v1/templates/{templateId}`	Оновлення шаблону
`DELETE`	`/api/v1/templates/{templateId}`	Видалення шаблону
`POST`	`/api/v1/templates/{templateId}/duplicate`	Дублювання шаблону

Застосування шаблону

Передайте templateId, коли створюєте QR-код. Дизайн шаблону застосовується до нового QR-коду. Будь-який із трьох об’єктів дизайну, надісланих у тому самому запиті, накладається поверх нього.

Копія, а не зв’язок. QR-код зберігає власну копію дизайну. Подальше редагування чи видалення шаблону на нього не впливає.
Лише дизайни Custom. Шаблон із designKind branded або ai не можна застосувати через API, і запит повертає 422 (art_template_unsupported).
Лише ваш робочий простір. Невідомий шаблон або шаблон з іншого робочого простору повертає 404.

Заголовки

string

обов'язково

Bearer, а за ним ваш API-ключ. Див. Автентифікація.

string

application/json. Обов’язковий для запитів із тілом.

Об’єкт шаблону

string

ID шаблону, наприклад qrt_8Hs2mQvKpLd4RtYw.

string

Назва, яку видно під час вибору шаблону.

string

Лише для читання. custom — дизайн, який API може повністю редагувати. branded і ai — дизайн Branded або AI, створений у панелі керування: його зображення не можна редагувати через API, і воно зберігається, коли ви змінюєте інші поля дизайну.

object

Збережений дизайн. Кожне поле має ту саму структуру, що й однойменне поле запиту, тож його можна надіслати назад.

Показати properties

object | null

Форми й кольори точок і кутів.

object | null

Рамка навколо QR-коду та її текст із закликом до дії.

object | null

Логотип у центрі.

string

Дата створення, ISO 8601.

string

Дата останнього оновлення, ISO 8601.

Список шаблонів

GET /api/v1/templates Повертає шаблони вашого робочого простору, від найновіших. Список посторінковий: див. Пагінація.

integer

за замовчуванням:"1"

Сторінка, яку потрібно повернути, 1 або більше.

integer

за замовчуванням:"100"

Кількість результатів на сторінці, від 1 до 100.

curl "https://getqr.com/api/v1/templates?page=1&pageSize=100" \
  -H "Authorization: Bearer $GETQR_API_KEY"

{
  "data": [
    {
      "id": "qrt_8Hs2mQvKpLd4RtYw",
      "name": "Brand blue",
      "designKind": "custom",
      "design": {
        "styles": {
          "dotsOptions": { "type": "rounded", "color": "#1E40AF" },
          "backgroundOptions": { "color": "#FFFFFF" }
        },
        "frameOptions": null,
        "logoOptions": null
      },
      "createdAt": "2026-07-20T09:12:00.000Z",
      "updatedAt": "2026-07-20T09:12:00.000Z"
    }
  ],
  "pagination": { "page": 1, "pageSize": 100, "total": 1, "hasMore": false }
}

Створення шаблону

POST /api/v1/templates Зберігає новий дизайн. Відповідає 201 Created. Поля дизайну перевіряються за каталогами з розділу Оформлення, тож невідома форма, рамка чи логотип відхиляються з 422.

string

обов'язково

Назва, яку видно під час вибору шаблону, від 1 до 40 символів.

object

Форми й кольори точок і кутів. Див. Оформлення.

object

Рамка навколо QR-коду та її текст із закликом до дії. Див. Оформлення.

object

Логотип у центрі: запропонований логотип або ваш власний файл, завантажений з target logo через Файли. Див. Оформлення.

curl -X POST "https://getqr.com/api/v1/templates" \
  -H "Authorization: Bearer $GETQR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Brand blue",
    "styles": {
      "dotsOptions": { "type": "rounded", "color": "#1E40AF" },
      "backgroundOptions": { "color": "#FFFFFF" }
    }
  }'

{
  "id": "qrt_8Hs2mQvKpLd4RtYw",
  "name": "Brand blue",
  "designKind": "custom",
  "design": {
    "styles": {
      "dotsOptions": { "type": "rounded", "color": "#1E40AF" },
      "backgroundOptions": { "color": "#FFFFFF" }
    },
    "frameOptions": null,
    "logoOptions": null
  },
  "createdAt": "2026-07-20T09:12:00.000Z",
  "updatedAt": "2026-07-20T09:12:00.000Z"
}

Отримання шаблону

GET /api/v1/templates/{templateId}

string

обов'язково

ID шаблону. Візьміть його з відповіді списку або створення.

curl "https://getqr.com/api/v1/templates/qrt_8Hs2mQvKpLd4RtYw" \
  -H "Authorization: Bearer $GETQR_API_KEY"

{
  "id": "qrt_8Hs2mQvKpLd4RtYw",
  "name": "Brand blue",
  "designKind": "custom",
  "design": {
    "styles": {
      "dotsOptions": { "type": "rounded", "color": "#1E40AF" },
      "backgroundOptions": { "color": "#FFFFFF" }
    },
    "frameOptions": null,
    "logoOptions": null
  },
  "createdAt": "2026-07-20T09:12:00.000Z",
  "updatedAt": "2026-07-20T09:12:00.000Z"
}

Оновлення шаблону

PATCH /api/v1/templates/{templateId} Надсилайте лише поля, які хочете змінити. Об’єкти дизайну об’єднуються зі збереженим дизайном, тож частковий styles зберігає решту. QR-коди, уже створені із шаблону, зберігають дизайн, з яким їх створено.

string

обов'язково

ID шаблону.

string

Нова назва, від 1 до 40 символів.

object

Зміни стилів, що об’єднуються зі збереженим styles.

object

Зміни рамки, що об’єднуються зі збереженою рамкою.

object

Зміни логотипа, що об’єднуються зі збереженим логотипом.

curl -X PATCH "https://getqr.com/api/v1/templates/qrt_8Hs2mQvKpLd4RtYw" \
  -H "Authorization: Bearer $GETQR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "name": "Brand blue (2026)" }'

{
  "id": "qrt_8Hs2mQvKpLd4RtYw",
  "name": "Brand blue (2026)",
  "designKind": "custom",
  "design": {
    "styles": {
      "dotsOptions": { "type": "rounded", "color": "#1E40AF" },
      "backgroundOptions": { "color": "#FFFFFF" }
    },
    "frameOptions": null,
    "logoOptions": null
  },
  "createdAt": "2026-07-20T09:12:00.000Z",
  "updatedAt": "2026-08-14T09:00:00.000Z"
}

Видалення шаблону

DELETE /api/v1/templates/{templateId} Видаляє шаблон. QR-коди, створені з нього, зберігають свій дизайн.

string

обов'язково

ID шаблону.

curl -X DELETE "https://getqr.com/api/v1/templates/qrt_8Hs2mQvKpLd4RtYw" \
  -H "Authorization: Bearer $GETQR_API_KEY"

{ "id": "qrt_8Hs2mQvKpLd4RtYw", "deleted": true }

Дублювання шаблону

POST /api/v1/templates/{templateId}/duplicate Створює копію з назвою <name> copy, з власним ID і незалежним дизайном, який можна вільно редагувати. Не приймає тіла запиту. Відповідає 201 Created.

string

обов'язково

ID шаблону, який потрібно скопіювати.

curl -X POST "https://getqr.com/api/v1/templates/qrt_8Hs2mQvKpLd4RtYw/duplicate" \
  -H "Authorization: Bearer $GETQR_API_KEY"

{
  "id": "qrt_2Kd9pLm4Xs7BnVcQ",
  "name": "Brand blue copy",
  "designKind": "custom",
  "design": {
    "styles": {
      "dotsOptions": { "type": "rounded", "color": "#1E40AF" },
      "backgroundOptions": { "color": "#FFFFFF" }
    },
    "frameOptions": null,
    "logoOptions": null
  },
  "createdAt": "2026-08-14T09:30:00.000Z",
  "updatedAt": "2026-08-14T09:30:00.000Z"
}

Поширені проблеми

404 "QR template not found."

templateId не відповідає шаблону вашого робочого простору. Візьміть його зі Списку шаблонів.

422 під час створення або оновлення шаблону

Поле дизайну не відповідає каталогам, наприклад невідомий тип точок, рамка чи запропонований логотип. Повідомлення називає поле. Див. Оформлення.

422 art_template_unsupported під час створення QR-коду

Шаблон використовує дизайн Branded або AI. Натомість застосуйте шаблон із designKind custom.

API

Застосування шаблону

Заголовки

Об’єкт шаблону

Список шаблонів

Створення шаблону

Отримання шаблону

Оновлення шаблону

Видалення шаблону

Дублювання шаблону

Поширені проблеми

Що далі

Оформлення

QR-коди

Шаблони в застосунку

Файли

​Застосування шаблону

​Заголовки

​Об’єкт шаблону

​Список шаблонів

​Створення шаблону

​Отримання шаблону

​Оновлення шаблону

​Видалення шаблону

​Дублювання шаблону

​Поширені проблеми

​Що далі

Оформлення

QR-коди

Шаблони в застосунку

Файли

Застосування шаблону

Заголовки

Об’єкт шаблону

Список шаблонів

Створення шаблону

Отримання шаблону

Оновлення шаблону

Видалення шаблону

Дублювання шаблону

Поширені проблеми

Що далі