Curseduca Contents
API Curseduca para manipulação dos conteúdos da plataforma
Matrículas
POST /enrollments
Parameters
No parameters
Request body - application/json
Example Value
{
"member": {
"id": 0,
"email": "string"
},
"contentId": 0
}
Responses
201
Matrícula criada com sucesso!
No links
404
Conteúdo/Membro não encontrado.
No links
409
Membro já matriculado no conteúdo.
No links
DELETE /enrollments/{id}
Parameters
id *
string(path)
id
Responses
200
Matrícula cancelada com sucesso!
No links
404
Conteúdo/Membro não encontrado.
No links
PUT / enrollments/{id}
Parameters
id *
string(path)
id
Responses
200
Matrícula atualizada com sucesso!
No links
404
Conteúdo/Membro não encontrado.
No links
PATCH /enrollments / {id} / restore
Parameters
id *
string(path)
id
Responses
200
Matrícula restaurada com sucesso!
No links
404
Conteúdo/Membro não encontrado.
No links
Fóruns
GET / forums
Parameters
No parameters
Responses
200
Fóruns listados com sucesso!
No links
GET / forums / {uuid}
Parameters
uuid *
string(path)
uuid
Responses
200
No links
PUT / forums / {uuid}
Parameters
uuid *
string(path)
uuid
Responses
200
No links
DELETE / forums / {uuid}
Parameters
uuid *
string(path)
uuid
Responses
200
No links
POST / forums / {uuid} / answer
Parameters
uuid *
string(path)
uuid
Responses
201
No links
PATCH / forums / {uuid} / pin
Parameters
uuid *
string(path)
uuid
Responses
200
No links
PATCH / forums / {uuid} / unpin
Parameters
uuid *
string(path)
uuid
Responses
200
No links
PATCH / forums / {uuid} / read
Parameters
uuid *
string(path)
uuid
Responses
200
No links
PATCH / forums / {uuid} / unread
Parameters
uuid *
string(path)
uuid
Responses
200
No links
PATCH / forums / {uuid} / disable-comments
Parameters
uuid *
string(path)
uuid
Responses
200
No links
PATCH / forums / {uuid} /enable-comments
Parameters
uuid *
string(path)
uuid
Responses
200
No links
POST / forums / {uuid} / share
Parameters
uuid *
string(path)
uuid
Responses
201
No links
Materiais
DELETE / lessons / {id}
Parameters
id *
number(path)
id
Responses
204
Aula removida com sucesso!
No links
Default
POST/lessons/{id}
Parameters
id *
string(path)
id
Responses
204
Aula salva com sucesso!
No links
GET/menus/current/{tenantUuid}
Parameters
Try it out
tenantUuid *
string(path)
tenantUuid
Responses
200
No links
GET/showcases/member/contents/is-watching
Parameters
No parameters
Responses
200
No links
GET/showcases/member/contents
Parameters
Authorization *
string(header)
Authorization
Responses
200
No links
DELETE/cache/community
Parameters
No parameters
Responses
200
No links
GET/tenants/using-community
Parameters
No parameters
Responses
200
No links
DELETE/forums/{forumId}/answers/{answerId}/delete
Parameters
answerId *
string(path)
answerId
Responses
200
No links
PATCH/quizes/members/questions/{memberQuestionId}/approve
Parameters
memberQuestionId *
string(path)
memberQuestionId
Responses
200
No links
PATCH/quizes/members/questions/{memberQuestionId}/reprove
Parameters
memberQuestionId
*string(path)
memberQuestionId
Responses
200
No links
POST/lessons/assessments/{memberAssessmentId}/correction
Parameters
memberAssessmentId *
string(path)
memberAssessmentId
Responses
201
No links
POST/lessons/{lessonId}/flashcards/{flashcardId}
Parameters
lessonId *
string(path)
lessonId
flashcardId *
string(path)
flashcardId
Responses
201
No links
POST/move-folder-to-other-community
Parameters
No parameters
Responses
201
No links
POST/emails
Parameters
No parameters
Responses
201
No links
DELETE/emails
Parameters
No parameters
Responses
200
No links
POST/orderbump
Parameters
No parameters
Responses
201
No links
DELETE/orderbump/{uuid}
Parameters
uuid *
string(path)
uuid
Responses
200
No links
GET/lessons/assessments/{memberAssessmentId}/attempt
Parameters
memberAssessmentId *
string(path)
memberAssessmentId
Responses
200
No links
GET/lessons/assessments/correction/{correctionId}
Parameters
correctionId *
string(path)
correctionId
admin *
string(query)
admin
Responses
200
No links
GET/lessons/{lessonId}/flashcards
Parameters
lessonId *
string(path)
lessonId
Responses
200
No links
GET/hc
Parameters
No parameters
Responses
200
No links
GET/orderbumps
Parameters
No parameters
Responses
200
No links
GET/reports/group/tenants
Parameters
No parameters
Responses
200
No links
GET/members/channels/has-access
Parameters
No parameters
Responses
200
No links
Relatórios
GET/api/reports/enrollments
Parameters
limit
number
(query)
Número de registros por página (max 100)
offset
number
(query)
Número de registros a serem ignorados
memberId
string
(query)
ID do membro para filtrar matrículas
export
string
(query)
Exportar relatório (true/false)
Responses
200
Relatório de matrículas gerado com sucesso!
Media type:
application/jsonControls
Example Value:
{
"metadata": {
"totalCount": 0,
"hasmore": true,
"limit": 0,
"offset": 0
},
"data": [
{
"id": 0,
"content": {
"id": 0,
"title": "string",
"slug": "string"
},
"startedAt": "2025-07-09T03:29:58.910Z",
"finishedAt": "2025-07-09T03:29:58.910Z",
"member": {
"id": 0,
"name": "string",
"email": "string",
"slug": "string",
"groupIds": [
0
]
},
"situationId": 0,
"progress": 0,
"expiresAt": "2025-07-09T03:29:58.910Z",
"expirationEnabled": true,
"integration": "string"
}
]
}
No links
GET/reports/progress
Parameters
limit
number
(query)
Número de registros por página (max 100)
offset
number
(query)
Número de registros a serem ignorados
content
string
(query)
Nome, slug ou ID do conteúdo
lesson
string
(query)
Nome ou ID da aula
section
string
(query)
Nome ou ID do módulos
finishedSince
string($date-time)
(query)
Data inicial de finalização da aula
finishedUntil
string($date-time)
(query)
Data final de finalização da aula
startUpdatedAt
string($date-time)
(query)
Data inicial de atualização
endUpdatedAt
string($date-time)
(query)
Data final de atualização
member
string
(query)
Nome, email, slug ou ID do membro
group
string
(query)
Nome ou ID do grupos
Responses
200
Relatório de progresso gerado com sucesso!
Media type:
application/jsonControls
Example Value:
{
"metadata": {
"totalCount": 0,
"hasmore": true,
"limit": 0,
"offset": 0
},
"data": {
"id": 0,
"finishedAt": "2025-07-09T03:29:58.915Z",
"lesson": {
"id": 0,
"title": "string",
"section": {
"id": 0,
"title": "string",
"content": {
"id": 0,
"title": "string",
"slug": "string"
}
}
},
"member": {
"id": 0,
"email": "string"
},
"enrollment": {
"id": 0,
"progress": 0,
"group": {
"id": 0,
"uuid": "string",
"name": "string"
}
}
}
}
No links
Showcases
GET/showcases
Parameters
No parameters
Responses
200
Vitrines listadas com sucesso!
Media type:
application/jsonControls
Example Value:
{
"contentId": "string",
"description": "string",
"title": "string",
"slug": "string",
"categoryId": "string",
"contentDisplayPage": "string",
"createdAt": "string",
"updatedAt": "string",
"customDisplayPage": "string",
"isContentShowcaseEnabled": "string",
"isCustomPageStudentsEnabled": "string",
"imageName": "string",
"imageAlt": "string",
"imageTitle": "string",
"imagePath": "string",
"order": "string",
"contentSection": "string",
"instructorSlug": "string",
"name": "string",
"instructorImagePath": "string",
"instructorImageName": "string",
"contentTypeId": "string",
"contentType": "string",
"contentCategory": "string",
"contentCategorySlug": "string",
"contentCategoryIcon": "string"
}
No links
GET/reports/progress
Parameters
limit
number
(query)
Número de registros por página (max 100)
offset
number
(query)
Número de registros a serem ignorados
content
string
(query)
Nome, slug ou ID do conteúdo
lesson
string
(query)
Nome ou ID da aula
section
string
(query)
Nome ou ID do módulos
finishedSince
string($date-time)
(query)
Data inicial de finalização da aula
finishedUntil
string($date-time)
(query)
Data final de finalização da aula
startUpdatedAt
string($date-time)
(query)
Data inicial de atualização
endUpdatedAt
string($date-time)
(query)
Data final de atualização
member
string
(query)
Nome, email, slug ou ID do membro
group
string
(query)
Nome ou ID do grupos
Responses
200
Relatório de progresso gerado com sucesso!
Media type:
application/jsonControls
Example Value:
{
"metadata": {
"totalCount": 0,
"hasmore": true,
"limit": 0,
"offset": 0
},
"data": {
"id": 0,
"finishedAt": "2025-07-09T03:29:58.915Z",
"lesson": {
"id": 0,
"title": "string",
"section": {
"id": 0,
"title": "string",
"content": {
"id": 0,
"title": "string",
"slug": "string"
}
}
},
"member": {
"id": 0,
"email": "string"
},
"enrollment": {
"id": 0,
"progress": 0,
"group": {
"id": 0,
"uuid": "string",
"name": "string"
}
}
}
}
No links
Comunidade
Last updated
Was this helpful?