Listar anamneses dos alunos

GET

/anamnese/alunos

const url = 'https://api-wellness.dinamopro.ai/v1/anamnese/alunos?limit=100&offset=0&status=pendente';
const options = {method: 'GET', headers: {'X-Api-Key': '<X-Api-Key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://api-wellness.dinamopro.ai/v1/anamnese/alunos?limit=100&offset=0&status=pendente' \
  --header 'X-Api-Key: <X-Api-Key>'

Retorna as anamneses preenchidas dos alunos do tenant.

Authorizations

ApiKeyAuth

Parameters

Query Parameters

limit

integer

default: 100 >= 1 <= 1000

Número máximo de registros retornados (1–1000).

offset

integer

Número de registros a pular (paginação).

id_aluno

string

/^[a-zA-Z0-9_]{1,64}$/

Filtrar por aluno.

status

string

Allowed values: pendente respondida refazer

Filtrar por status da anamnese.

Responses

200

Lista de anamneses dos alunos.

application/json

Array<object>

object

string format: uuid

id_aluno

string

status

string

Allowed values: pendente respondida refazer

resposta

object

key

additional properties

any

criado_em

string format: date-time

Example

[
  {
    "status": "pendente"
  }
]

400

Header obrigatório ausente ou body inválido.

application/json

object

error

string

Allowed values: Missing X-Api-Key header Invalid JSON body

Example

{
  "error": "Missing X-Api-Key header"
}

401

API key inválida, inativa ou sem permissão para o endpoint.

application/json

object

error

string

Example

{
  "error": "API Key inválida"
}

422

Um ou mais parâmetros de query ou campos do body falharam na validação de schema.

application/json

object

error

object

key

additional properties

Array<string>

Example

{
  "error": {
    "ativo": [
      "Invalid enum value. Expected 'true' | 'false', received 'sim'"
    ]
  }
}