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…

Tool
filmo_account_get
Access: Read

Result

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "filmo_account_get",
    "arguments": {}
  }
}

generated from the schema

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

Arguments

This tool takes no arguments.

Result

On success the result carries structuredContent with data and meta. These are the attributes of data.

Show the attributes of data
namestring

Name of the account.

timezonestring

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

currencystring

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

countrystring

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

languagestring

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

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

trialobject

Trial period of the account.

Show child attributes
trial.activeboolean

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

trial.endsAtstring<date-time> | null

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

apiKeyobject

The key that made the request. Never its secret.

Show child attributes
apiKey.idstring

Identifier of the API key that made the request.

apiKey.namestring

Name given to the key when it was created.

apiKey.scopesstring[]

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

rateLimitsobject

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

Show child attributes
rateLimits.globalobject

Requests per minute across the whole API.

Show child attributes
rateLimits.global.perMinuteinteger

rateLimits.availabilityobject

Requests per minute of the availability checks, counted apart.

Show child attributes
rateLimits.availability.perMinuteinteger

apiobject

The contract this account is served with.

Show child attributes
api.versionstring

Version of the public API contract.

api.docsUrlstring

Where the documentation of this version lives.

An error is a result with isError: true and the problem in content[0].text; there is no structuredContent. See Errors.

Sample prompts

Which Filmo account am I connected to, and what are its time zone and currency?

The same operation by REST

This tool runs GET /api/v1/account.

  • 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.

  • Guides

    Safe writes

    An assistant that can write can also write the wrong thing. Decide which tools need a person, retry without duplicating, and know what a write sets in motion.

  • Guides

    Errors

    A tool error is a result with isError: true and the problem in the first text block. Branch on its code.

Was this page helpful?