Modelos

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

A API do GetQR está em versão beta e só está disponível para alguns espaços de trabalho. Os detalhes podem mudar antes do lançamento geral.

Um modelo guarda um design reutilizável: styles, frameOptions e logoOptions. Nunca inclui conteúdo nem uma ligação. Os modelos são partilhados com todo o espaço de trabalho.

Método	Caminho	Descrição
`GET`	`/api/v1/templates`	Listar modelos
`POST`	`/api/v1/templates`	Criar um modelo
`GET`	`/api/v1/templates/{templateId}`	Obter um modelo
`PATCH`	`/api/v1/templates/{templateId}`	Atualizar um modelo
`DELETE`	`/api/v1/templates/{templateId}`	Eliminar um modelo
`POST`	`/api/v1/templates/{templateId}/duplicate`	Duplicar um modelo

Aplicar um modelo

Passe templateId quando criar um código QR. O design do modelo é aplicado ao novo código QR. Os objetos de design que enviar no mesmo pedido são combinados sobre ele.

Copiado, não associado. O código QR guarda a sua própria cópia do design. Editar ou eliminar o modelo mais tarde não o altera.
Apenas designs personalizados. Um modelo com designKind branded ou ai não pode ser aplicado através da API e devolve 422 (art_template_unsupported).
Apenas o seu espaço de trabalho. Um modelo desconhecido, ou de outro espaço de trabalho, devolve 404.

Cabeçalhos

string

obrigatório

Bearer seguido da sua chave de API. Consulte Autenticação.

string

application/json. Obrigatório nos pedidos com corpo.

O objeto de modelo

string

ID do modelo, por exemplo qrt_8Hs2mQvKpLd4RtYw.

string

Nome apresentado ao escolher um modelo.

string

Só de leitura. custom é um design que a API pode editar na totalidade. branded e ai são um Branded design ou um AI design criado no painel: a respetiva imagem não pode ser editada através da API e é mantida quando altera os outros campos de design.

object

O design guardado. Cada campo tem a mesma estrutura do campo do pedido com o mesmo nome, pelo que o pode reenviar.

Mostrar properties

object | null

Formas e cores dos pontos e dos cantos.

object | null

Moldura à volta do código QR e o respetivo texto de apelo à ação.

object | null

Logótipo no centro.

string

Data de criação, ISO 8601.

string

Data da última atualização, ISO 8601.

Listar modelos

GET /api/v1/templates Devolve os modelos do seu espaço de trabalho, do mais recente para o mais antigo. A lista é paginada: consulte Paginação.

integer

padrão:"1"

Página a devolver, 1 ou mais.

integer

padrão:"100"

Resultados por página, de 1 a 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 }
}

Criar um modelo

POST /api/v1/templates Guarda um novo design. Responde 201 Created. Os campos de design são validados face aos catálogos em Personalização, pelo que uma forma, moldura ou logótipo desconhecido é rejeitado com 422.

string

obrigatório

Nome apresentado ao escolher um modelo, de 1 a 40 caracteres.

object

Formas e cores dos pontos e dos cantos. Consulte Personalização.

object

Moldura desenhada à volta do código QR e o respetivo texto de apelo à ação. Consulte Personalização.

object

Logótipo colocado no centro: um logótipo sugerido, ou o seu próprio ficheiro carregado com o target logo de Ficheiros. Consulte Personalização.

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

Obter um modelo

GET /api/v1/templates/{templateId}

string

obrigatório

ID do modelo. Obtenha-o na resposta da listagem ou da criação.

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

Atualizar um modelo

PATCH /api/v1/templates/{templateId} Envie apenas os campos que pretende alterar. Os objetos de design são combinados com o design guardado, pelo que um styles parcial mantém o resto. Os códigos QR já criados a partir do modelo mantêm o design com que foram criados.

string

obrigatório

ID do modelo.

string

Novo nome, de 1 a 40 caracteres.

object

Alterações de estilo, combinadas com o styles guardado.

object

Alterações da moldura, combinadas com a moldura guardada.

object

Alterações do logótipo, combinadas com o logótipo guardado.

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

Eliminar um modelo

DELETE /api/v1/templates/{templateId} Elimina o modelo. Os códigos QR criados a partir dele mantêm o seu design.

string

obrigatório

ID do modelo.

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

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

Duplicar um modelo

POST /api/v1/templates/{templateId}/duplicate Cria uma cópia com o nome <name> copy, com um ID próprio e um design independente que pode editar livremente. Não aceita corpo de pedido. Responde 201 Created.

string

obrigatório

ID do modelo a copiar.

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

Problemas comuns

404 "QR template not found."

O templateId não corresponde a nenhum modelo do seu espaço de trabalho. Obtenha-o em Listar modelos.

422 ao criar ou atualizar um modelo

Um campo de design não corresponde aos catálogos, por exemplo um tipo de ponto, uma moldura ou um logótipo sugerido desconhecido. A mensagem indica o campo. Consulte Personalização.

422 art_template_unsupported ao criar um código QR

O modelo usa um Branded design ou um AI design. Aplique antes um modelo com designKind custom.

API

Aplicar um modelo

Cabeçalhos

O objeto de modelo

Listar modelos

Criar um modelo

Obter um modelo

Atualizar um modelo

Eliminar um modelo

Duplicar um modelo

Problemas comuns

Próximos passos

Personalização

Códigos QR

Modelos na aplicação

Ficheiros

​Aplicar um modelo

​Cabeçalhos

​O objeto de modelo

​Listar modelos

​Criar um modelo

​Obter um modelo

​Atualizar um modelo

​Eliminar um modelo

​Duplicar um modelo

​Problemas comuns

​Próximos passos

Personalização

Códigos QR

Modelos na aplicação

Ficheiros

Aplicar um modelo

Cabeçalhos

O objeto de modelo

Listar modelos

Criar um modelo

Obter um modelo

Atualizar um modelo

Eliminar um modelo

Duplicar um modelo

Problemas comuns

Próximos passos