Listar alunos

GET

/alunos

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

• Produção

Retorna todos os alunos do tenant.

Authorizations

• ApiKeyAuth

Parameters

Query Parameters

ativo

string

Allowed values: true false

Filtrar por status ativo/inativo.

limit

integer

default: 100 >= 1 <= 1000

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

offset

integer

0

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

academia_id

string format: uuid

Filtrar alunos por academia (UUID).

id_personal

string

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

Filtrar alunos por personal trainer.

nome

string

>= 1 characters <= 100 characters

Busca parcial no nome do aluno (case-insensitive, 1–100 caracteres).

Responses

200

Lista de alunos.

Media type application/json

Array<object>

object

id

string format: uuid

nome

string

email

string format: email

ativo

boolean

academia_id

string format: uuid

criado_em

string format: date-time

Example ^generated

[
  {
    "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "nome": "example",
    "email": "hello@example.com",
    "ativo": true,
    "academia_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "criado_em": "2026-04-15T12:00:00Z"
  }
]

400

Header obrigatório ausente ou body inválido.

Media type 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.

Media type 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.

Media type application/json

object

error

object

key

additional properties

Array<string>

Example

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