GET/api/report-masks

Buscar todos os máscaras

Buscar todos as máscaras

Access Token

Para realizar requisições GET, POST, PUT, DELETE e PATCH nos endpoints da API você precisa de uma chave de autorização. Chamamos essa chave de accessToken.

Para ter acesso ao accessToken, é necessário que o usuário master da licença efetue a liberação deste pela interface do ImageMais Clinic. O accessToken tem validade de 1 hora.

Headers

Nome	Tipo	Obrig.	Descrição
`Authorization`	string	Sim	Token de autenticação no formato Bearer {accessToken}

AuthorizationOBRIGATÓRIO

Tipo:string

Token de autenticação no formato Bearer {accessToken}

Parâmetros

Nome	Tipo	Obrig.	Descrição
`name`	string	Não	Busca por nome da máscara
Este parâmetro permite filtrar as máscaras por nome. O valor deve corresponder ao nome ou parte do nome da máscara cadastrada no sistema. Observação: Se o parâmetro for passado sem valor (exemplo: `name=asta`), a API retornará status 200 (OK), porém sem dados no array de resposta.
`examType`	string	Não	Busca por tipo de exame
Este parâmetro permite filtrar as máscaras por tipo de exame. O valor deve corresponder ao tipo de exame cadastrado no sistema. Observação: Se o parâmetro for passado com um tipo que não existe (exemplo: `examType=glicose`), a API retornará status 200 (OK), porém sem dados no array de resposta.
`isActive`	boolean	Não	Busca por máscaras ativas
Este parâmetro permite filtrar as máscaras por status de ativação. Quando definido como `true`, retorna apenas máscaras ativas. Quando definido como `false`, retorna apenas máscaras inativas. Observação: Se o parâmetro for passado sem valor (exemplo: `isActive=`), a API retornará status 200 (OK), porém sem dados no array de resposta.
`page`	number	Não	Página da busca
`limit`	number	Não	Limite de máscaras a serem retornadas
`SortBy`	string	Não	Campo para ordenação. Valores permitidos: 'name', 'examType', 'createdAt', 'updatedAt'. Padrão: 'createdAt'
`SortOrder`	string	Não	Direção da ordenação. Valores permitidos: 'asc', 'desc'. Padrão: 'desc'

nameOPCIONAL

Tipo:string

Busca por nome da máscara

Este parâmetro permite filtrar as máscaras por nome. O valor deve corresponder ao nome ou parte do nome da máscara cadastrada no sistema.

Observação: Se o parâmetro for passado sem valor (exemplo: name=asta), a API retornará status 200 (OK), porém sem dados no array de resposta.

examTypeOPCIONAL

Tipo:string

Busca por tipo de exame

Este parâmetro permite filtrar as máscaras por tipo de exame. O valor deve corresponder ao tipo de exame cadastrado no sistema.

Observação: Se o parâmetro for passado com um tipo que não existe (exemplo: examType=glicose), a API retornará status 200 (OK), porém sem dados no array de resposta.

isActiveOPCIONAL

Tipo:boolean

Busca por máscaras ativas

Este parâmetro permite filtrar as máscaras por status de ativação. Quando definido como true, retorna apenas máscaras ativas. Quando definido como false, retorna apenas máscaras inativas.

Observação: Se o parâmetro for passado sem valor (exemplo: isActive=), a API retornará status 200 (OK), porém sem dados no array de resposta.

pageOPCIONAL

Tipo:number

Página da busca

limitOPCIONAL

Tipo:number

Limite de máscaras a serem retornadas

SortByOPCIONAL

Tipo:string

Campo para ordenação. Valores permitidos: 'name', 'examType', 'createdAt', 'updatedAt'. Padrão: 'createdAt'

SortOrderOPCIONAL

Tipo:string

Direção da ordenação. Valores permitidos: 'asc', 'desc'. Padrão: 'desc'

Request URL

https://api-dev.imagemais.com/api/report-masks?isActive=true&limit=20&sortBy=createdAt&sortOrder=asc

Respostas

{
  "data": [
    {
  ...

{
  "data": [
    {
      "id": 5,
      "name": "Hemograma Completo",
      "description": "Template para hemograma completo com todos os parâmetros",
      "content": "<div class=\"header\"><h2>{{NOME_PACIENTE}} - {{IDADE_PACIENTE}}</h2></div>",
      "examType": "Hemograma",
      "isActive": true,
      "createdAt": "2025-12-18T10:25:35.394Z",
      "updatedAt": "2025-12-18T10:25:35.394Z"
    },
    {
      "id": 4,
      "name": "TESTE RÁPIDO DE GRAVIDEZ",
      "description": "",
      "content": "<p><strong>Resultado:</strong><br><br><strong>Positivo:</strong><strong> </strong>Houve a presença do hormônio gonadotrofina coriônica humana (hCG)<br><strong>Negativo:</strong> Não houve a presença do hormônio gonadotrofina coriônica humana (hCG)<br><br><strong>Material:</strong><strong> </strong>SORO<br><strong>Marca:</strong><strong> </strong>ADVAGEN<br><strong>Registro:</strong>&nbsp;ANVISA 81472060010</p>\n<p><br><strong>Observação:</strong><br>Como ocorre com todos os testes rápidos, que servem apenas como triagem diagnóstica, o clínico deve avaliar os resultados em conjunto com outras informações clinicas, para dar um diagnóstico definitio.</p>",
      "examType": "TESTE RAPIDO DE GRAVIDEZ - BETA HCG",
      "isActive": true,
      "createdAt": "2025-10-16T18:10:34.386Z",
      "updatedAt": "2025-10-16T18:10:34.386Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 10,
    "total": 5,
    "totalPages": 1
  }
}

{
  "data": [],
  "pagination": {
  ...

{
  "data": [],
  "pagination": {
    "page": 1,
    "limit": 10,
    "total": 0,
    "totalPages": 0
  }
}

{
  "message": "SortOrder must be one of the following values: asc, desc",
  "error": "Bad Request"
  ...

{
  "message": "SortOrder must be one of the following values: asc, desc",
  "error": "Bad Request"
}

{
  "message": "SortBy must be one of the following values: name, examType, createdAt, updatedAt",
  "error": "Bad Request"
  ...

{
  "message": "SortBy must be one of the following values: name, examType, createdAt, updatedAt",
  "error": "Bad Request"
}

{
  "message": "limit must not be greater than 100",
  "error": "Bad Request"
  ...

{
  "message": "limit must not be greater than 100",
  "error": "Bad Request"
}

{
  "statusCode": 401,
  "message": "invalid token"
  ...

{
  "statusCode": 401,
  "message": "invalid token"
}

{
  "statusCode": 401,
  "message": "jwt expired"
  ...

{
  "statusCode": 401,
  "message": "jwt expired"
}

{
  "statusCode": 500,
  "message": "Internal server error"
  ...

{
  "statusCode": 500,
  "message": "Internal server error"
}