Cuenta

Detalles del plan, lista de espacios de trabajo y carpetas del usuario actual

Cuenta

Los endpoints de cuenta devuelven información sobre el plan de suscripción actual, la lista de espacios de trabajo disponibles y la estructura de carpetas. Todas las solicitudes requieren autorización mediante Authorization: Bearer YOUR_API_TOKEN.

Descarga la versión en markdown de la sección "Cuenta" para usar en ChatGPT / otros LLMs:

/static/api/account.md
AI Markdown

Información del plan de suscripción GET /api/v3/service/tariff

Devuelve los datos del plan de suscripción actual: código del plan, nombre y días restantes.

Respuesta

Campo Tipo Descripción
tariff.code string Código del plan (p. ej. free, pro)
tariff.name string Nombre visible del plan
tariff.days_left integer|null Días restantes en el plan; null para planes ilimitados
GET /api/v3/service/tariff 
curl -X GET "https://api.surveyninja.io/api/v3/service/tariff" \ -H "Authorization: Bearer YOUR_API_TOKEN" \ -H "Accept: application/json"

Ejemplo de respuesta:

{ "tariff": { "code": "pro", "name": "Pro", "days_left": 24 } }

Listar espacios de trabajo GET /api/v3/service/workspaces

Devuelve una lista paginada de los espacios de trabajo disponibles para el usuario actual, con el rol y el plan de cada espacio de trabajo.

Parámetros de consulta

Parámetro Tipo Predeterminado Descripción
page integer 1 Número de página
per_page integer 20 Espacios de trabajo por página

Campos de respuesta (elemento del array)

Campo Tipo Descripción
id integer ID del espacio de trabajo
name string Nombre del espacio de trabajo
role string Rol del usuario actual (owner, admin, member)
tariff string Código del plan del espacio de trabajo

La respuesta también incluye los campos de paginación estándar: total, current_page, last_page, per_page.

GET /api/v3/service/workspaces 
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"

Ejemplo de respuesta:

{ "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 carpetas GET /api/v3/service/folders

Devuelve una lista plana de todas las carpetas del usuario actual, incluida la carpeta predeterminada. Las carpetas se usan para organizar encuestas dentro de un espacio de trabajo.

Campos de respuesta (elemento del array)

Campo Tipo Descripción
id integer ID de la carpeta
name string Nombre de la carpeta
is_default boolean true — carpeta predeterminada (las nuevas encuestas sin carpeta especificada se guardan aquí)
pos integer Posición de la carpeta en la lista para ordenar
GET /api/v3/service/folders 
curl -X GET "https://api.surveyninja.io/api/v3/service/folders" \ -H "Authorization: Bearer YOUR_API_TOKEN" \ -H "Accept: application/json"

Ejemplo de respuesta:

[ { "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 } ]