テンプレート

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 }
}

GetQR API はベータ版で、一部のワークスペースでのみご利用いただけます。正式リリースまでに内容が変更される場合があります。

テンプレートには、再利用できるデザイン（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`	テンプレートを複製する

テンプレートを適用する

QR コードを作成するときに templateId を渡します。テンプレートのデザインが新しい QR コードに適用されます。同じリクエストで 3 つのデザインオブジェクトのいずれかを送ると、テンプレートの上にマージされます。

リンクではなくコピー。 QR コードはデザインのコピーを独自に持ちます。後でテンプレートを編集または削除しても、QR コードは変わりません。
カスタムデザインのみ。 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 design または AI design です。その画像は 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 ページあたりの件数。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

中央に配置するロゴ。おすすめのロゴ、またはファイルの 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 になる

デザインのフィールドがカタログと一致していません。たとえば、不明なドットの種類、フレーム、おすすめのロゴです。メッセージにフィールド名が示されます。カスタマイズをご覧ください。

QR コードの作成時に 422 art_template_unsupported

テンプレートが Branded design または AI design を使っています。代わりに、designKind が custom のテンプレートを適用してください。

API

テンプレートを適用する

ヘッダー

テンプレートオブジェクト

テンプレートを一覧表示する

テンプレートを作成する

テンプレートを取得する

テンプレートを更新する

テンプレートを削除する

テンプレートを複製する

よくある問題

次のステップ

カスタマイズ

QR コード

アプリでのテンプレート

ファイル

​テンプレートを適用する

​ヘッダー

​テンプレートオブジェクト

​テンプレートを一覧表示する

​テンプレートを作成する

​テンプレートを取得する

​テンプレートを更新する

​テンプレートを削除する

​テンプレートを複製する

​よくある問題

​次のステップ

カスタマイズ

QR コード

アプリでのテンプレート

ファイル

テンプレートを適用する

ヘッダー

テンプレートオブジェクト

テンプレートを一覧表示する

テンプレートを作成する

テンプレートを取得する

テンプレートを更新する

テンプレートを削除する

テンプレートを複製する

よくある問題

次のステップ