Conta
Detalhes do plano, lista de espaços de trabalho e pastas do usuário atual
Conta
Os endpoints de conta retornam informações sobre o plano de assinatura atual, a lista de espaços de trabalho disponíveis e a estrutura de pastas. Todas as requisições exigem autorização via Authorization: Bearer YOUR_API_TOKEN.
Baixe a versão em markdown da seção "Conta" para uso no ChatGPT / outros LLMs:
Informações do plano de assinatura GET /api/v3/service/tariff
Retorna os dados do plano de assinatura atual: código do plano, nome e dias restantes.
Resposta
| Campo | Tipo | Descrição |
|---|---|---|
| tariff.code | string | Código do plano (ex.: free, pro) |
| tariff.name | string | Nome de exibição do plano |
| tariff.days_left | integer|null | Dias restantes no plano; null para planos ilimitados |
curl -X GET "https://api.surveyninja.io/api/v3/service/tariff" \ -H "Authorization: Bearer YOUR_API_TOKEN" \ -H "Accept: application/json"Exemplo de resposta:
{ "tariff": { "code": "pro", "name": "Pro", "days_left": 24 } }Listar espaços de trabalho GET /api/v3/service/workspaces
Retorna uma lista paginada dos espaços de trabalho disponíveis para o usuário atual, com o papel e o plano de cada espaço de trabalho.
Parâmetros de consulta
| Parâmetro | Tipo | Padrão | Descrição |
|---|---|---|---|
| page | integer | 1 | Número da página |
| per_page | integer | 20 | Espaços de trabalho por página |
Campos da resposta (elemento do array)
| Campo | Tipo | Descrição |
|---|---|---|
| id | integer | ID do espaço de trabalho |
| name | string | Nome do espaço de trabalho |
| role | string | Papel do usuário atual (owner, admin, member) |
| tariff | string | Código do plano do espaço de trabalho |
A resposta também inclui os campos de paginação padrão: total, current_page, last_page, per_page.
curl -X GET "https://api.surveyninja.io/api/v3/service/workspaces?page=1&per_page=20" \ -H "Authorization: Bearer YOUR_API_TOKEN" \ -H "Accept: application/json"Exemplo de resposta:
{ "data": [ { "id": 1, "name": "My workspace", "role": "owner", "tariff": "pro" }, { "id": 7, "name": "Team project", "role": "member", "tariff": "business" } ], "total": 2, "current_page": 1, "last_page": 1, "per_page": 20 }Listar pastas GET /api/v3/service/folders
Retorna uma lista simples de todas as pastas do usuário atual, incluindo a pasta padrão. As pastas são usadas para organizar pesquisas dentro de um espaço de trabalho.
Campos da resposta (elemento do array)
| Campo | Tipo | Descrição |
|---|---|---|
| id | integer | ID da pasta |
| name | string | Nome da pasta |
| is_default | boolean | true — pasta padrão (novas pesquisas sem pasta especificada são salvas aqui) |
| pos | integer | Posição da pasta na lista para ordenação |
curl -X GET "https://api.surveyninja.io/api/v3/service/folders" \ -H "Authorization: Bearer YOUR_API_TOKEN" \ -H "Accept: application/json"Exemplo de resposta:
[ { "id": 1, "name": "General", "is_default": true, "pos": 0 }, { "id": 5, "name": "Marketing", "is_default": false, "pos": 1 }, { "id": 8, "name": "HR", "is_default": false, "pos": 2 } ]