Skip to main content

GET Buscar Versão do Modelo

Uma versão específica do modelo, com o template completo (schema).

Autenticação necessária

Envie o header Authorization: Bearer {accessToken} (token de usuário) ou x-api-key: {apiKey} (integrações). Veja Autenticação.

Permissão necessária

Exige a permissão read_document_templates.


Endpoint​

GET https://api-dev.imagemais.com.br/api/document-templates/{type}/versions/{version}

Parâmetros de Rota​

NomeTipoObrigatórioDescrição
typestring✅Tipo do documento: LETTERHEAD, PRESCRIPTION, EXAMS, REFERRAL, MEDICAL_CERTIFICATE, DECLARATION, LIFESTYLE_ADVICE, APPOINTMENT_RECEIPT, PROCEDURE_REFERRAL, BUDGET, COLLECTION_RECEIPT, STANDALONE_DECLARATION, RAPID_TEST_HISTORY
versionnumber✅Número da versão

Requisição​

curl -X 'GET' \
'https://api-dev.imagemais.com.br/api/document-templates/PRESCRIPTION/versions/3' \
-H 'accept: application/json' \
-H 'Authorization: Bearer {accessToken}'

Respostas​

200 Sucesso​

{
"type": "PRESCRIPTION",
"version": 3,
"active": true,
"createdAt": "2026-11-10T14:00:00.000Z",
"createdBy": {
"id": 12,
"name": "Nome Exemplo"
},
"schema": {
"basePdf": {
"width": 210,
"height": 297,
"padding": [
58,
20,
80,
20
]
},
"schemas": [
[
{
"name": "itens",
"type": "table"
}
]
]
},
"id": 41
}

400 Requisição inválida​

Retornado quando type não é um dos tipos válidos ou version não é numérico (Validation failed (numeric string is expected)).

{
"message": "Validation failed (enum string is expected)",
"error": "Bad Request",
"statusCode": 400
}

403 Sem permissão​

{
"message": "Permissões insuficientes",
"error": "Forbidden",
"statusCode": 403
}

404 Não encontrado​

{
"message": "Versão do modelo não encontrada",
"error": "Not Found",
"statusCode": 404
}