Temas
Gerencie os temas de design de pesquisas no seu espaço de trabalho
Temas do espaço de trabalho
Os temas de design permitem definir esquemas de cores, fontes, fundos e estilos de botões para as pesquisas. Cada tema está vinculado a um espaço de trabalho e pode ser aplicado a várias pesquisas ao mesmo tempo.
URL base para todas as requisições nesta seção: /api/v3/service/workspace/{id}/themes, onde {id} — é o ID do espaço de trabalho.
Baixe a versão em markdown da seção «Temas do espaço de trabalho» para uso no ChatGPT / outros LLMs:
AI Markdown
/static/api/themes.md
AI Markdown
Listar temas do espaço de trabalho GET /api/v3/service/workspace/{id}/themes
Retorna uma lista paginada de temas de design para o espaço de trabalho especificado.
Parâmetros de consulta
| Parâmetro | Tipo | Padrão | Descrição |
|---|---|---|---|
| page | integer | 1 | Número da página |
| per_page | integer | 20 | Temas por página |
GET /api/v3/service/workspace/{id}/themes
curl -X GET "https://api.surveyninja.io/api/v3/service/workspace/1/themes?page=1&per_page=20" \ -H "Authorization: Bearer YOUR_API_TOKEN" \ -H "Accept: application/json"Obter tema GET /api/v3/service/workspace/{id}/themes/{theme_id}
Retorna os dados completos de um tema específico, incluindo todos os campos de cor, estilo e metadados.
Campos principais da resposta
| Campo | Tipo | Descrição |
|---|---|---|
| id | integer | ID do tema |
| name | string | Nome do tema |
| header_color | string | Cor do cabeçalho (HEX) |
| buttons_color | string | Cor do botão (HEX) |
| bg_color | string | Cor de fundo (HEX) |
| widget_active_color | string | Cor do widget ativo (HEX) |
| base_font_id | integer | ID da fonte (ver referência abaixo) |
| base_font_title | string | Nome da fonte |
| sort | integer | Ordem de classificação |
| created_at | string | Criado em (ISO 8601) |
| updated_at | string | Atualizado em (ISO 8601) |
GET /api/v3/service/workspace/{id}/themes/{theme_id}
curl -X GET "https://api.surveyninja.io/api/v3/service/workspace/1/themes/42" \ -H "Authorization: Bearer YOUR_API_TOKEN" \ -H "Accept: application/json"Criar tema POST /api/v3/service/workspace/{id}/themes
Cria um novo tema no espaço de trabalho. O parâmetro quiz_id é obrigatório — o tema é criado com base nas configurações da pesquisa especificada. Todos os outros campos são opcionais e substituem os valores da pesquisa.
Corpo da requisição (JSON)
| Parâmetro | Obr. | Descrição |
|---|---|---|
| quiz_id | Sim | UUID da pesquisa na qual o tema será baseado |
| name | Não | Nome do tema |
| header_color | Não | Cor do cabeçalho (HEX) |
| buttons_color | Não | Cor do botão (HEX) |
| bg_color | Não | Cor de fundo (HEX) |
| base_font_id | Não | ID da fonte (ver referência abaixo) |
POST /api/v3/service/workspace/{id}/themes
curl -X POST "https://api.surveyninja.io/api/v3/service/workspace/1/themes" \ -H "Authorization: Bearer YOUR_API_TOKEN" \ -H "Content-Type: application/json" \ -d '{ "quiz_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "name": "My Theme", "buttons_color": "#3B82F6", "bg_color": "#F9FAFB" }'Atualizar tema POST /api/v3/service/workspace/{id}/themes/{theme_id}
Atualização parcial do tema — envie apenas os campos a serem alterados. Todos os parâmetros são opcionais.
Parâmetros do corpo da requisição
| Parâmetro | Tipo | Descrição |
|---|---|---|
| name | string | Nome do tema |
| header_color | string | Cor do cabeçalho (HEX) |
| buttons_color | string | Cor do botão (HEX) |
| bg_color | string | Cor de fundo (HEX) |
| widget_active_color | string | Cor do widget ativo (HEX) |
| base_font_id | integer | ID da fonte (ver referência) |
| buttons_type_id | integer | 1 — preenchido, 2 — com borda |
| buttons_radius | integer | Raio da borda do botão (px) |
| answer_options_radius | integer | Raio da borda das opções de resposta (px) |
| answer_border | boolean | Exibir borda nas opções de resposta |
| background_type_id | integer | 1 — cor/imagem, 2 — gradiente |
| background_opacity | integer | Opacidade do fundo (0–100) |
| background_lightness | integer | Brilho da imagem de fundo |
| background_saturate | integer | Saturação da imagem de fundo |
| background_contrast | integer | Contraste da imagem de fundo |
| bg_gradient_start | string | Cor inicial do gradiente (HEX) |
| bg_gradient_end | string | Cor final do gradiente (HEX) |
| bg_gradient_vector | integer | Direção do gradiente (graus, 0–360) |
| bg_image_file_id | integer | ID do arquivo de imagem de fundo |
| background_position_id | integer | Posição do fundo (ver referência) |
| background_placement_id | integer | Disposição do fundo: 1 esticar, 2 tamanho original, 3 cobrir |
| bg_logo_file_id | integer | ID do arquivo de logotipo de fundo |
| bg_logo_position_id | integer | Posição do logotipo de fundo (ver referência) |
| bg_logo_size_id | integer | Tamanho do logotipo de fundo |
POST /api/v3/service/workspace/{id}/themes/{theme_id}
curl -X POST "https://api.surveyninja.io/api/v3/service/workspace/1/themes/42" \ -H "Authorization: Bearer YOUR_API_TOKEN" \ -H "Content-Type: application/json" \ -d '{ "name": "Updated theme", "buttons_color": "#10B981", "buttons_radius": 8 }'Copiar tema POST /api/v3/service/workspace/{id}/themes/{theme_id}/copy
Cria uma cópia completa do tema no mesmo espaço de trabalho. Nenhum corpo de requisição é necessário. A resposta é o novo objeto de tema.
POST /api/v3/service/workspace/{id}/themes/{theme_id}/copy
curl -X POST "https://api.surveyninja.io/api/v3/service/workspace/1/themes/42/copy" \ -H "Authorization: Bearer YOUR_API_TOKEN" \ -H "Accept: application/json"Excluir tema DELETE /api/v3/service/workspace/{id}/themes/{theme_id}
Exclui um tema do espaço de trabalho. Todas as pesquisas que usam este tema são automaticamente alternadas para o tema padrão.
DELETE /api/v3/service/workspace/{id}/themes/{theme_id}
curl -X DELETE "https://api.surveyninja.io/api/v3/service/workspace/1/themes/42" \ -H "Authorization: Bearer YOUR_API_TOKEN" \ -H "Accept: application/json"Tabelas de referência
Fontes (base_font_id)
| ID | Fonte | ID | Fonte |
|---|---|---|---|
| 1 | Nativa (sistema) | 23 | Nunito |
| 2 | Roboto | 24 | Oswald |
| 3 | Open Sans | 25 | Playfair Display |
| 4 | Lato | 26 | PT Sans |
| 5 | Montserrat | 27 | PT Serif |
| 6 | Raleway | 28 | Rubik |
| 7 | Source Sans Pro | 29 | Ubuntu |
| 8 | Roboto Condensed | 30 | Manrope |
| 9 | Roboto Mono | 31 | Inter |
| 10 | Roboto Slab | 32 | Mulish |
| 11 | Noto Sans | 33 | Poppins |
| 12 | Noto Serif | 34 | Quicksand |
| 13 | Merriweather | 35 | Comfortaa |
| 14 | Libre Baskerville | 36 | Exo 2 |
| 15 | Lobster | 37 | Fira Sans |
| 16 | Pacifico | 38 | Cabin |
| 17 | Dancing Script | 39 | Nunito Sans |
| 18 | Caveat | 40 | Jost |
| 19 | Permanent Marker | 41 | Unbounded |
| 20 | Indie Flower | 42 | Wix Madefor Display |
| 21 | Abril Fatface | 43 | Onest |
| 22 | Fjalla One | 44 | Golos Text |
Tipo de botão (buttons_type_id)
| ID | Estilo |
|---|---|
| 1 | fundo (preenchido) |
| 2 | borda (com contorno) |
Tipo de fundo (background_type_id)
| ID | Tipo |
|---|---|
| 1 | cor_imagem (cor ou imagem) |
| 2 | gradiente (gradiente) |
Disposição do fundo (background_placement_id)
| ID | Modo |
|---|---|
| 1 | esticar |
| 2 | tamanho original |
| 3 | cobrir |
Posição do fundo (background_position_id)
| ID | Posição |
|---|---|
| 1 | center center |
| 2 | left center |
| 3 | right center |
| 4 | center top |
| 5 | center bottom |
| 6 | left top |
| 7 | right top |
| 8 | left bottom |
| 9 | right bottom |