---
title: "Get API root"
method: GET
path: "/"
tags: ["API root"]
---

# Get API root

`GET /`

## Request

- Base URL: `https://sandbox-api.paddle.com`
- URL: `https://sandbox-api.paddle.com/`
- Auth: none required

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`

The request has succeeded.

- object
  - `data` RootContext, required: Represents the API root entity, with information about the Paddle API and the caller making the request.
    - `api` RootApi, required: Information about the Paddle API serving this request. Always present, even for requests without valid credentials.
      - `name` string, required: Human-readable name of the API.
      - `version` string, required: Version of the API serving this request.
      - `environment` 'production' | 'sandbox', required: Environment that the API is serving the request in.
      - `documentation_url` string, uri, required: Link to the API reference documentation.
    - `caller` RootCaller, required: Information about the caller making this request.
      - `auth_type` 'api_key' | 'oauth' | 'client_token' | 'session', required: Authentication method used for this request. `null` when the request doesn't have valid credentials.
      - `account` RootCallerAccount, 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` string[], required: Names of the permissions granted to the caller, for example `transaction.read`. Empty when the request doesn't have valid credentials.
  - `meta` Meta, 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.

## Other responses

- `default`: An unexpected error response.

## Changes

- **2026-10-19** (v1) `4f35a8c6ea4d`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/paddlehq/apis/paddle-api/changes/get.md)

---

[API](https://skmtc.dev/paddlehq/apis/paddle-api.md) - [All operations](https://skmtc.dev/paddlehq/apis/paddle-api/llms.txt) - [OpenAPI document](https://skmtc.dev/paddlehq/apis/paddle-api/revisions/bbc0c72039c8?raw)