Skip to main content
GET
/
api
/
users
/
courses
Matrículas de aluno
curl --request GET \
  --url https://kong.api.toolzz.com.br/api/users/courses \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "institution_code": "<string>"
}'
{
  "data": {
    "id": 123,
    "uuid": "<string>",
    "name": "<string>",
    "email": "<string>",
    "cpf": "<string>",
    "enrollment_start_date": "<string>",
    "enrollment_end_date": "<string>",
    "created_at": "<string>",
    "updated_at": "<string>",
    "ultima_atividade": "<string>",
    "school": {
      "id": 123,
      "titulo": "<string>"
    },
    "address": {
      "id": 123,
      "address_id": 123,
      "cep": "<string>",
      "uf": "<string>",
      "cidade": "<string>",
      "bairro": "<string>",
      "logradouro": "<string>",
      "numero": "<string>",
      "complemento": "<string>"
    },
    "custom_form": [
      {
        "enunciado": "<string>",
        "pergunta_id": 123,
        "resposta": "<string>"
      }
    ],
    "institution": [
      {
        "id": 123,
        "subdomain": "<string>",
        "titulo": "<string>"
      }
    ]
  }
}

​
Parâmetros

​
by
string
required
Pode ser “email” ou “id”.
​
value
string
required
Valor de acordo com a opção “by”. Pode ser o e-mail ou o ID de um usuário.
​
institution_code
string
required
Subdomínio da sua instituição, conforme aparece na URL original.
Antes de utilizar este endpoint, certifique-se de possuir os seguintes parâmetros disponíveis:
  • by obrigatório: Uma flag que define o tipo de busca que você deseja realizar. Os valores válidos são email ou cpf.
  • value obrigatório: O valor do e-mail ou CPF que você deseja pesquisar.
  • institution_code obrigatório: Subdomínio da sua instituição, conforme aparece na URL original.

​
Descrição da Resposta

Abaixo está um exemplo da resposta retornada por este endpoint.
​
data
object
Detalhes do perfil do usuário.
A data de início enrollment_start_date será ignorada para cursos que não utilizam essa configuração. Só é aplicável a componentes específicos da plataforma.

​
⚠️ Validações

Se enrollment_end_date for anterior a ‘enrollment_start_date’, a requisição será rejeitada com erro: 
{
  "error": "End date cannot be previous to Start date"
}

​
Segurança

Para acessar este endpoint, é necessário enviar um token de acesso válido no cabeçalho de autorização (Authorization) da requisição. Além disso, a API conta com outras medidas de segurança para proteger os dados dos usuários.