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…
account:readaccount:read- 120/min
- Server annotation: Read-only
- Server annotation: Idempotent
Result
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
Name of the account.
IANA timezone of the business, the one bare days in filters are read in.
ISO 4217 currency of the account; documents may carry their own.
ISO 3166-1 alpha-2 country of the business.
Default language of error messages for this key (BCP 47), unless Accept-Language says otherwise.
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
Trial period of the account.
Show child attributesHide child attributes
true while the trial of the account lasts: every add-on is unlocked.
End of the trial in ISO 8601 UTC; null if none.
The key that made the request. Never its secret.
Show child attributesHide child attributes
Identifier of the API key that made the request.
Name given to the key when it was created.
Scopes granted to the key, the ones its requests can use.
Usage limits of the key, the ones the RateLimit-* headers report.
Show child attributesHide child attributes
Requests per minute across the whole API.
Show child attributesHide child attributes
Requests per minute of the availability checks, counted apart.
Show child attributesHide child attributes
The contract this account is served with.
Show child attributesHide child attributes
Version of the public API contract.
Where the documentation of this version lives.
An error is a result with isError: true and the problem in content[0].; 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.
Related pages
Link to this section: Related pagesAccount
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: trueand the problem in the first text block. Branch on itscode.
Was this page helpful?