> For the complete documentation index, see [llms.txt](https://developer.paddle.com/llms.txt).

# GET /

**Get API root**

Returns information about the Paddle API and the caller making the request, including their account and permissions.

Authentication is optional. A request with no credentials still succeeds, with `caller.auth_type` and `caller.account` set to `null` and an empty `caller.permissions`. A request with an API key that isn't valid returns a `403` error, like any other operation. To check that an API key works, make sure `caller.account` isn't `null`.

## Response (200)

- `data`: object (required) — Represents the API root entity, with information about the Paddle API and the caller making the request.
  - `api`: object (required) — Information about the Paddle API serving this request.
    - `name`: string (required) — Human-readable name of the API.
    - `version`: string (required) — Version of the API serving this request.
    - `environment`: string (required) — Environment that the API is serving the request in.
      - `production` — Live production environment.
      - `sandbox` — Sandbox testing environment.
    - `documentation_url`: string (uri) (required) — Link to the API reference documentation.
  - `caller`: object (required) — Information about the caller making this request.
    - `auth_type`: string | null (required) — Authentication method used for this request. `null` when the request doesn't have valid credentials.
      - `api_key` — Authenticated with an API key.
      - `oauth` — Authenticated with an OAuth access token, like the one a live Paddle MCP server connection uses.
      - `client_token` — Authenticated with a client-side token, used by Paddle.js.
      - `session` — Authenticated with a Paddle dashboard session.
    - `account`: object | null (required) — Account that the caller is authenticated against. `null` when the request doesn't have valid credentials.
      - `id`: string (required) — Unique Paddle ID for this account, prefixed with `slr_`.
      - `name`: string (required) — Name of this account.
    - `permissions`: array (required) — Names of the permissions granted to the caller, for example `transaction.read`. Empty when the request doesn't have valid credentials.
- `meta`: object (required) — Information about this response.
  - `request_id`: string (required) — Unique ID for the request relating to this response. Provide this when contacting Paddle support about a specific request.

### Response example

```json
{
  "data": {
    "api": {
      "name": "Paddle API",
      "version": "1",
      "environment": "production",
      "documentation_url": "https://developer.paddle.com/api-reference/overview"
    },
    "caller": {
      "auth_type": null,
      "account": null,
      "permissions": []
    }
  },
  "meta": {
    "request_id": "3f1e6c8a-2b4d-4a90-8c7e-1d2f3a4b5c6d"
  }
}
```