Skip to main content
GET
Consultar área de membros

Escopo

Authorizations

Authorization
string
header
required

Token de autenticação do tipo Bearer {access_token}, onde {access_token} é o token obtido no fluxo de autenticação.

Path Parameters

id
string<uuid>
required

Response

id
string<uuid>
required
read-only

Identificador único da área de membros

name
string
required

Nome da área de membros

Maximum string length: 255
product
string
required
read-only

Produto desta área de membros

logo
string<uri> | null
required
read-only

Logo da área de membros

logo_original
string<uri> | null
required
read-only

Logo da área de membros antes do corte, base para novos cortes

banner
string<uri> | null
required
read-only

Banner da área de membros

banner_original
string<uri> | null
required
read-only

Banner da área de membros antes do corte, base para novos cortes

banner_mobile
string<uri> | null
required
read-only

Banner da home da área de membros para o celular, em 3:2

banner_mobile_original
string<uri> | null
required
read-only

Banner mobile da área de membros antes do corte, base para novos cortes

support_email
string<email>
required

E-mail de suporte exibido ao aluno da área de membros

Maximum string length: 254
copy_status
required
  • copying - Copiando
  • done - Concluída
  • failed - Falhou
Available options:
copying,
done,
failed
created_at
string<date-time>
required
read-only

Data de criação da área de membros

updated_at
string<date-time>
required
read-only

Data de atualização da área de membros

slug
string | null
Maximum string length: 255
status
enum<string>

Status atual da área de membros

  • draft - Rascunho
  • published - Publicado
  • deleted - Excluído
Available options:
draft,
published,
deleted
description
string

Descrição da área de membros

comments_enabled
boolean

Indica se os comentários estão habilitados na área de membros

always_show_showcase
boolean

Indica se a vitrine é exibida mesmo quando o produto tem um curso único

single_card_in_student_list
boolean

Indica se o aluno vê a área como um card só na lista de cursos, em vez de um card por curso

show_students_count
boolean

Indica se o total de alunos da área de membros é exibido ao aluno

show_free_lessons_row
boolean

Indica se a vitrine mostra no topo as aulas gratuitas do conteúdo pago

public_showcase
boolean

Indica se a vitrine da área é servida a quem ainda não é aluno

hero_title
string

Título da seção hero da área de membros

Maximum string length: 255
hero_description
string

Descrição da seção hero da área de membros

hero_cta_label
string

Label do botão de call to action da seção hero

Maximum string length: 255
hero_cta_section
string<uuid> | null
title_font_family
string | null

Fonte do título e do subtítulo da seção hero

Maximum string length: 100
title_color
string | null

Cor do título da seção hero, em hexadecimal (#RRGGBB ou #RRGGBBAA)

Maximum string length: 9
Pattern: ^#(?:[0-9a-fA-F]{6}|[0-9a-fA-F]{8})$
subtitle_color
string | null

Cor do subtítulo da seção hero, em hexadecimal (#RRGGBB ou #RRGGBBAA)

Maximum string length: 9
Pattern: ^#(?:[0-9a-fA-F]{6}|[0-9a-fA-F]{8})$
cta_font_family
string | null

Fonte do botão de call to action da seção hero

Maximum string length: 100
cta_color
string | null

Cor de fundo do botão de call to action, em hexadecimal (#RRGGBB ou #RRGGBBAA)

Maximum string length: 9
Pattern: ^#(?:[0-9a-fA-F]{6}|[0-9a-fA-F]{8})$
logo_font_family
string | null

Fonte do rótulo exibido ao lado do logo

Maximum string length: 100
logo_label
string | null

Texto exibido ao lado do logo (vazio significa logo sem rótulo)

Maximum string length: 255
banner_overlay_enabled
boolean | null

Indica se a sobreposição escura sobre a imagem do banner está ligada

banner_overlay_color
string | null

Cor da sobreposição do banner, em hexadecimal (#RRGGBB ou #RRGGBBAA)

Maximum string length: 9
Pattern: ^#(?:[0-9a-fA-F]{6}|[0-9a-fA-F]{8})$
banner_overlay_opacity
integer | null

Opacidade da sobreposição do banner em percentual (Inteiro entre 0 e 100)

Required range: 0 <= x <= 100
screen_capture_blocked
boolean

Indica se o app e a área do aluno bloqueiam a captura do conteúdo onde o sistema permite

ebook_watermark_enabled
boolean

Indica se todo PDF da área é entregue ao aluno com a marca d'água

video_watermark_enabled
boolean

Indica se o player desenha a marca d'água sobre os vídeos da área

watermark_fields
enum<string>[]
  • email - E-mail do aluno
  • name - Nome do aluno
  • cpf - CPF
Available options:
email,
name,
cpf