Tag
Rota da API para listar as tags da sua plataforma e descobrir o ID de cada uma.
Use esta rota para descobrir o ID das tags da plataforma. Com o ID em mãos, você pode aplicar ou remover tags de um aluno e listar os alunos de uma tag pelas rotas de Usuário.
Base: https://<sua-plataforma>/api/v1 · Autenticação: cabeçalho Authorization com sua chave (veja API).
Listar tags
GET /tagDevolve todas as tags da plataforma, em ordem alfabética. Esta rota não tem parâmetros nem paginação.
curl https://escola.asalahub.com/api/v1/tag \
-H "Authorization: ash_sua_chave_aqui"{
"success": true,
"code": 200,
"data": {
"itens": [
{ "id": 7, "nome": "Turma Outubro" },
{ "id": 3, "nome": "VIP" }
]
},
"profiler": { "start": 1789737057.12, "finish": 1789737057.13, "process": 0.01 }
}| Campo | Descrição |
|---|---|
itens[].id | ID da tag |
itens[].nome | Nome da tag |
Tags relacionadas
- Adicionar uma tag ao aluno:
POST /usuario/adicionar_tag - Remover uma tag do aluno:
POST /usuario/remover_tag - Listar alunos de uma tag:
GET /usuario/lista_por_tag/{tag}