*REST API › Endpoint reference › Account & access › 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.

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

`GET /api/v1/account` — scope `account:read`

Scope: `account:read` · 120/min · If-None-Match · MCP: `filmo_account_get`

## Authorizations

Bearer API key with the scope below. `account:read`

## Headers

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `If-None-Match` | string | No | Conditional read: the `ETag` of the copy you already have. If the resource has not changed, the response is `304` with no body. |

## Request examples

*Get the account*

**cURL**

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

**Node.js**

```javascript
fetch('https://app.filmo.io/api/v1/account', {
  headers: {
    Authorization: 'Bearer YOUR_FILMO_API_KEY'
  }
})
```

**Python**

```python
import requests

requests.get("https://app.filmo.io/api/v1/account",
    headers={
      "Authorization": "Bearer YOUR_FILMO_API_KEY"
    }
)
```

## Response

Response schema: `AccountDto`

| Status | Description |
| --- | --- |
| 200 | Successful response. |
| 304 | Not modified: the `If-None-Match` sent matches the current `ETag`. No body; the copy you have is current. |
| 401 | Authentication failed (unauthorized, api_key_invalid, api_key_revoked, api_key_expired, api_key_owner_inactive, api_key_owner_not_admin). |
| 403 | Not allowed (insufficient_scope: the API key does not have the required scope, named in `requiredScope`; forbidden: the owner of the key lacks the permission the operation requires). `insufficient_scope` is answered before the request counts against the rate limit, so it carries no `RateLimit-*` headers; `forbidden` does. |
| 429 | Rate limit exceeded (rate_limited): retry after `Retry-After` seconds; `RateLimit-*` says which quota ran out. |
| 500 | Internal error (internal_error). |

**200**

| Name | Type | Description |
| --- | --- | --- |
| `data` | object | The account that made the request, its key and its usage limits. |
| `data.name` | string | Name of the account. |
| `data.timezone` | string | IANA timezone of the business, the one bare days in filters are read in. |
| `data.currency` | string | ISO 4217 currency of the account; documents may carry their own. |
| `data.country` | string | ISO 3166-1 alpha-2 country of the business. |
| `data.language` | string | Default language of error messages for this key (BCP 47), unless Accept-Language says otherwise. |
| `data.addons` | string[] | Ids of the add-ons the account has access to today. A resource behind an add-on not listed here responds 402. `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.trial` | object | Trial period of the account. |
| `data.trial.active` | boolean | true while the trial of the account lasts: every add-on is unlocked. |
| `data.trial.endsAt` | string<date-time> | End of the trial in ISO 8601 UTC; null if none. |
| `data.apiKey` | object | The key that made the request. Never its secret. |
| `data.apiKey.id` | string | Identifier of the API key that made the request. |
| `data.apiKey.name` | string | Name given to the key when it was created. |
| `data.apiKey.scopes` | string[] | Scopes granted to the key, the ones its requests can use. |
| `data.rateLimits` | object | Usage limits of the key, the ones the RateLimit-* headers report. |
| `data.rateLimits.global` | object | Requests per minute across the whole API. |
| `data.rateLimits.global.perMinute` | integer |  |
| `data.rateLimits.availability` | object | Requests per minute of the availability checks, counted apart. |
| `data.rateLimits.availability.perMinute` | integer |  |
| `data.api` | object | The contract this account is served with. |
| `data.api.version` | string | Version of the public API contract. |
| `data.api.docsUrl` | string | Where the documentation of this version lives. |
| `meta` | object | Additional information about the response. |
| `meta.warnings` | object[] | Lifecycle warnings; present only when the operation is deprecated. |
| `meta.warnings.code` | string | Stable warning code. `deprecated` |
| `meta.warnings.message` | string | For people: what is deprecated, until when, and what to use. |
| `meta.warnings.sunset` | string | Day (YYYY-MM-DD) the operation stops being served. |
| `meta.warnings.replacement` | string | `operationId` of the operation to use instead, or null if there is none. |
| `meta.warnings.link` | string | Where the deprecation is documented (the changelog). |

*Example response · 200*

```json
{
  "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"
    }
  }
}
```

304: No body.

## Errors

| Status | Codes | Meaning |
| --- | --- | --- |

## Deprecation

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

---

Canonical URL: https://docs.filmo.io/rest-api/endpoint-reference/account/get-the-account  
Last updated: 2026-10-25