Listar comentários
Lista comentários
Required scopes:nutror_comments_read
GET
https://api.eduzz.com/nutror/v1/comments
Query params
pageRequired
number
Página atual
itemsPerPageRequired
number
Número de itens por página
courseId
number
Filtra comentários pelo id do curso
lessonId
number
Filtra comentários pelo id da aula
status
enum
Filtra comentários pelo status
approved
rejected
inModeration
favorite
boolean
Filtra comentários favoritados ou não favoritados
answered
boolean
Filtra comentários respondidos ou não respondidos
read
boolean
Filtra comentários lidos ou não lidos
fixed
boolean
Filtra comentários fixados ou não
email
string
Filtra comentários pelo e-mail
Response params (200)
pages
number
Número de páginas
page
number
Página atual
itemsPerPage
number
Número máximo de itens por página
totalItems
number
Número total de items
items
array of object
Comentários
items[n].id
number
Id do comentário
items[n].text
string
Texto do comentário
items[n].isRead
boolean
Comentário lido ou não lido
items[n].isFavorite
boolean
Comentário favoritado ou não favoritado
items[n].createdAt
datetime
Data de criação do comentário
items[n].isFixed
boolean
Comentário está fixado ou não fixado
items[n].status
enum
Status do comentário
approved
rejected
inModeration
items[n].type
enum
Formato do comentário
html
text
items[n].author
string
Autor do comentário
items[n].lessonId
number
Aula que o comentário pertence
items[n].isAnswered
boolean
Comentário respondido ou não respondido
Status codes
| Status | Descrição |
| 200 | Success |
Exemplos
1curl --request GET \
2 --url 'https://api.eduzz.com/nutror/v1/comments?page=1&itemsPerPage=10' \
3 --header 'Accept: application/json' \
4 --header 'Content-Type: application/json' \
5 --header 'authorization: Bearer {{YOUR_ACCESS_TOKEN}}'Response
1{
2 "pages": 1,
3 "page": 1,
4 "itemsPerPage": 10,
5 "totalItems": 1,
6 "items": [
7 {
8 "id": 12345,
9 "type": "text",
10 "isRead": false,
11 "author": "Carlos Eduardo",
12 "status": "inModeration",
13 "text": "Esse é um comentário",
14 "lessonId": 54321,
15 "createdAt": "2023-04-28T20:47:32Z",
16 "isFixed": false,
17 "isFavorite": false,
18 "isAnswered": true
19 }
20 ]
21}