Account

Get the account

Returns the account that made the request: its name, the timezone bare days are read in, its currency and country, the add-ons it has access to (a resource behind an add-on not listed responds 402), whether it is in its trial period, the API key that made the request with its scopes, the usage limits the RateLimit-* headers report, and the version of this contract.

GET

/api/v1/account

curl https://app.filmo.io/api/v1/account \
  --header "Authorization: Bearer $FILMO_API_KEY"

Node.jsfetch('https://app.filmo.io/api/v1/account', { headers: { Authorization: 'Bearer YOUR_FILMO_API_KEY' } })Pythonimport requests requests.get("https://app.filmo.io/api/v1/account", headers={ "Authorization": "Bearer YOUR_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"
    }
  }
}

// No body.

{
  "type": "https://docs.filmo.io/errors/unauthorized",
  "title": "Unauthorized",
  "status": 401,
  "code": "unauthorized",
  "detail": "Missing Authorization header: Bearer <api key>",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c"
}

{
  "type": "https://docs.filmo.io/errors/insufficient_scope",
  "title": "Insufficient scope",
  "status": 403,
  "code": "insufficient_scope",
  "detail": "The API key does not have the required scope (orders:write)",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c",
  "requiredScope": "account:read"
}

{
  "type": "https://docs.filmo.io/errors/rate_limited",
  "title": "Rate limit exceeded",
  "status": 429,
  "code": "rate_limited",
  "detail": "Rate limit exceeded: retry in 30 seconds",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c",
  "retryAfter": 30
}

{
  "type": "https://docs.filmo.io/errors/internal_error",
  "title": "Internal error",
  "status": 500,
  "code": "internal_error",
  "detail": "Internal error",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c"
}

Generated from the schema

It is the first call of any integration: it replaces guessing.

Authorizations

Bearer API key with the scope below. account:read

Headers

If-None-Matchstring

Conditional read: the ETag of the copy you already have. If the resource has not changed, the response is 304 with no body.

Example:"\"3sT3d9pBvZq4h2N0w8x1YkLmQ7c\""

Response

application/json

Successful response.

Response schema: AccountDto

Envelope: AccountResponse. meta.warnings is present only when the operation is deprecated.

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

dataobject

The account that made the request, its key and its usage limits.

Show child attributes

data.namestring

Name of the account.

data.timezonestring

IANA timezone of the business, the one bare days in filters are read in.

data.currencystring

ISO 4217 currency of the account; documents may carry their own.

data.countrystring

ISO 3166-1 alpha-2 country of the business.

data.languagestring

Default language of error messages for this key (BCP 47), unless Accept-Language says otherwise.

data.addonsstring[]

Ids of the add-ons the account has access to today. A resource behind an add-on not listed here responds 402.

Available options: 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

Trial period of the account.

Show child attributes

data.trial.activeboolean

true while the trial of the account lasts: every add-on is unlocked.

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

End of the trial in ISO 8601 UTC; null if none.

data.apiKeyobject

The key that made the request. Never its secret.

Show child attributes

data.apiKey.idstring

Identifier of the API key that made the request.

data.apiKey.namestring

Name given to the key when it was created.

data.apiKey.scopesstring[]

Scopes granted to the key, the ones its requests can use.

data.rateLimitsobject

Usage limits of the key, the ones the RateLimit-* headers report.

Show child attributes

data.rateLimits.globalobject

Requests per minute across the whole API.

Show child attributes

data.rateLimits.global.perMinuteinteger

data.rateLimits.availabilityobject

Requests per minute of the availability checks, counted apart.

Show child attributes

data.rateLimits.availability.perMinuteinteger

data.apiobject

The contract this account is served with.

Show child attributes

data.api.versionstring

Version of the public API contract.

data.api.docsUrlstring

Where the documentation of this version lives.

metaobject

Additional information about the response.

Show child attributes

meta.warningsobject[]

Lifecycle warnings; present only when the operation is deprecated.

Show child attributes

meta.warnings.codestring

Stable warning code.

Available options: deprecated

meta.warnings.messagestring

For people: what is deprecated, until when, and what to use.

meta.warnings.sunsetstring

Day (YYYY-MM-DD) the operation stops being served.

meta.warnings.replacementstring | null

operationId of the operation to use instead, or null if there is none.

meta.warnings.linkstring

Where the deprecation is documented (the changelog).

Errors

401, 403, 429, 500 can be returned by any operation. Errors

Deprecation

This operation is not deprecated. Deprecations are announced with a Deprecation header and a sunset date. Versioning policy

Account & access
Account
The account that made the request, its key and its usage limits.

Was this page helpful?

Request examples

Authorizations

Headers

Response

Errors

Deprecation

Related

Related pages

Account