Buscar por curso

GET
https://api.eduzz.com/nutror/v1/courses/:courseId
Required scopes:nutror_courses_read

Buscar por um curso em específico

Path params

courseId

Id do curso

Response params (200)

id
number

Id do curso

title
string

Nome do curso

description
string

Descrição do curso

published
boolean

Status que identifica se o curso foi publicado

replyEmailNullable
string

O e-mail atrelado a este campo receberá notificações de interações dos alunos,como comentários ou mensagens diretas relacionadas ao curso

daysAvailableNullable
number

Define a quantidade de dias em que o aluno terá acesso ao curso. Este período sempre considera a partir da data em que o curso foi liberado para o aluno

releaseDate
string

Define a data em que o curso estará disponível para os alunos

progressBar
boolean

Define se a barra de progresso do curso será exibida para os alunos

pixelFacebookNullable
string

Pixel do Facebook

pixelGoogleAnalyticsNullable
string

Google Analytics

durationNullable
number

Carga horária do curso

certificateProgressNullable
number

Porcentagem necessária para obter o certificado

supportExternalUrlNullable
string

Url que direciona para uma página de suporte externo

allowMultipleAccess
boolean

Permite múltiplos acessos de um mesmo usuário no curso

secretaryStatus
boolean

Status de utilização do plugin de secretaria

secretaryUrlNullable
string

Url da secretaria

customization
object

Customizações do curso

customization.background
string

Imagem de fundo para tema escuro

customization.backgroundLight
string

Imagem de fundo para tema claro

customization.modulesDefaultImage
string

Imagem padrão para ser utilizada em todos os módulos

customization.lessonsDefaultImage
string

Imagem padrão para ser utilizada em todas as aulas

Status codes

StatusDescrição
200Success
403Este usuário não tem permissão
404Dados não encontrados

Exemplos

1curl --request GET \
2	--url https://api.eduzz.com/nutror/v1/courses/12345 \
3	--header 'Accept: application/json' \
4	--header 'Content-Type: application/json' \
5	--header 'authorization: Bearer {{YOUR_ACCESS_TOKEN}}'
Response
1{
2  "id": 12351,
3  "title": "Novo curso!",
4  "description": "Este é curso dedicado para especialistas",
5  "published": true,
6  "replyEmail": "email-reply@gmail.com",
7  "daysAvailable": 365,
8  "allowManualWatch": false,
9  "releaseDate": "2024-08-27",
10  "progressBar": true,
11  "pixelFacebook": "123456789",
12  "pixelGoogleAnalytics": "UA-123456789",
13  "duration": 2400,
14  "type": 1,
15  "certificateProgress": 100,
16  "supportExternalUrl": "https://www.minha-pagina-de-ajuda.com",
17  "allowMultipleAccess": false,
18  "secretaryStatus": true,
19  "secretaryUrl": "https://www.example.com",
20  "customization": {
21    "background": "https://www.minha-imagem.com/card.jpg",
22    "backgroundLight": "https://www.minha-imagem.com/card-light.jpg",
23    "modulesDefaultImage": "https://www.minha-imagem.com/module/image.jpg",
24    "lessonsDefaultImage": "https://www.minha-imagem.com/lesson/image.jpg"
25  }
26}