Cuenta

Obtener la cuenta

Devuelve la cuenta que hizo la petición: su nombre, la zona horaria en la que se leen las fechas sin hora, su divisa y su país, los add-ons a los que tiene acceso (un recurso detrás de un add-on que no figura responde 402), si está en periodo de prueba, la clave de API que hizo la petición con sus scopes, los límites de uso que informan las cabeceras RateLimit-* y la versión de este contrato.

GET
/api/v1/account

Ejemplos de petición

curl https://app.filmo.io/api/v1/account \
  --header "Authorization: Bearer $FILMO_API_KEY"
{
  "data": {
    "name": "Example account",
    "timezone": "Europe/Madrid",
    "currency": "EUR",
    "country": "ES",
    "language": "es-ES",
    "addons": [
      "platform"
    ],
    "trial": {
      "active": true,
      "endsAt": "2026-09-01T08:00:00.000Z"
    },
    "apiKey": {
      "id": "api_key_9f3a2b",
      "name": "Example api key",
      "scopes": [
        "Example scopes"
      ]
    },
    "rateLimits": {
      "global": {
        "perMinute": 50
      },
      "availability": {
        "perMinute": 50
      }
    },
    "api": {
      "version": "Example version",
      "docsUrl": "https://example.com/resource"
    }
  }
}

Generado a partir del esquema

Es la primera llamada de cualquier integración: sustituye a adivinar.

Autorizaciones

Clave de API como Bearer, con el permiso de abajo. account:read

Cabeceras

If-None-Matchstring

Lectura condicional: el ETag de la copia que ya tienes. Si el recurso no ha cambiado, la respuesta es 304 sin cuerpo.

Ejemplo:"\"3sT3d9pBvZq4h2N0w8x1YkLmQ7c\""

Respuesta

application/json

Respuesta correcta.

Esquema de la respuesta: AccountDto

Sobre: AccountResponse. meta.warnings solo aparece cuando la operación está obsoleta.

Cabeceras: X-Request-Id · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset · ETag

dataobject

La cuenta que hizo la petición, su clave y sus límites de uso.

Mostrar atributos hijos
data.namestring

Nombre de la cuenta.

data.timezonestring

Zona horaria IANA del negocio, aquella en la que se leen las fechas sin hora de los filtros.

data.currencystring

Moneda de la cuenta en ISO 4217; los documentos pueden llevar la suya.

data.countrystring

País del negocio en ISO 3166-1 alpha-2.

data.languagestring

Idioma por defecto de los mensajes de error de esta clave (BCP 47), salvo que Accept-Language indique otro.

data.addonsstring[]

Ids de los add-ons a los que la cuenta tiene acceso hoy. Un recurso tras un add-on que no figura aquí responde 402.

Opciones disponibles: platform, user-seat, connected-account, extra-tax-cif, qr-codes, incidence, purchases, activity-log, custom-fields, profitability, web-builder, crm, consignments, email-calendar, sales-documents, internal-bookings, internal-communication, advanced-user-permissions, ai-pack-25k, ai-pack-55k, ai-pack-115k

data.trialobject

Periodo de prueba de la cuenta.

Mostrar atributos hijos
data.trial.activeboolean

true mientras dura el periodo de prueba de la cuenta: todos los add-ons están desbloqueados.

data.trial.endsAtstring<date-time> | null

Fin de la prueba en ISO 8601 UTC; null si no hay.

data.apiKeyobject

La clave que hizo la petición. Nunca su secreto.

Mostrar atributos hijos
data.apiKey.idstring

Identificador de la clave de API que hizo la petición.

data.apiKey.namestring

Nombre dado a la clave cuando se creó.

data.apiKey.scopesstring[]

Scopes concedidos a la clave, los que pueden usar sus peticiones.

data.rateLimitsobject

Límites de uso de la clave, los que informan las cabeceras RateLimit-*.

Mostrar atributos hijos
data.rateLimits.globalobject

Peticiones por minuto en toda la API.

Mostrar atributos hijos
data.rateLimits.global.perMinuteinteger

data.rateLimits.availabilityobject

Peticiones por minuto de las consultas de disponibilidad, contadas aparte.

Mostrar atributos hijos
data.rateLimits.availability.perMinuteinteger

data.apiobject

El contrato con el que se sirve a esta cuenta.

Mostrar atributos hijos
data.api.versionstring

Versión del contrato de la API pública.

data.api.docsUrlstring

Dónde está la documentación de esta versión.

metaobject

Información adicional sobre la respuesta.

Mostrar atributos hijos
meta.warningsobject[]

Avisos del ciclo de vida; solo aparecen cuando la operación está obsoleta.

Mostrar atributos hijos
meta.warnings.codestring

Código de aviso estable.

Opciones disponibles: deprecated

meta.warnings.messagestring

Para personas: qué está obsoleto, hasta cuándo y qué usar.

meta.warnings.sunsetstring

Día (YYYY-MM-DD) en que la operación deja de estar disponible.

meta.warnings.replacementstring | null

operationId de la operación que hay que usar en su lugar, o null si no hay ninguna.

Errores

401, 403, 429, 500 los puede devolver cualquier operación. Errores

Obsolescencia

Esta operación no está obsoleta. Las obsolescencias se anuncian con la cabecera Deprecation y una fecha de retirada. Política de versiones

  • Cuenta y acceso

    Cuenta

    La cuenta que hizo la petición, su clave y sus límites de uso.

¿Te ha resultado útil esta página?