Account & access

Account

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

Schemas: AccountDto

{
  "name": "Example",
  "timezone": "string",
  "currency": "EUR",
  "country": "ES",
  "language": "es-ES",
  "addons": [
    "platform"
  ],
  "trial": {
    "active": true,
    "endsAt": "2026-09-01T08:00:00Z"
  },
  "apiKey": {
    "id": "id_8f2a1c",
    "name": "Example",
    "scopes": [
      "string"
    ]
  },
  "rateLimits": {
    "global": {
      "perMinute": 1
    },
    "availability": {
      "perMinute": 1
    }
  },
  "api": {
    "version": "string",
    "docsUrl": "https://example.com"
  }
}

Generated from the schema

The account that made the request: its name, timezone, currency, country and language, the add-ons it has, whether it is in trial, the API key that made the call with its scopes, the usage limits and the version of the contract. It is read-only and it is the first call of any integration, because it tells you how to read dates and amounts and which resources answer 402. Read it with GET /api/v1/account.

Attributes

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.

Values

addons: 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

Returned by

GET /api/v1/account — Get the account

Modified by

No operation.

Was this page helpful?