For AI agents and LLMs: a structured documentation index is available at /llms.txt. Every page has a Markdown sibling — append .md to any URL.

Skip to content
Paddle Docs home

API root

The API root returns information about the Paddle API and the caller making the request, including whether it's a sandbox or live request, how it was authenticated, the account, and its permissions.

The API root is the base URL of the Paddle API. It returns information about the API that served a request, and about the caller that made it.

Use it to check credentials before you rely on them. For example, confirm that you're about to make changes in sandbox rather than live, or that an API key has the permissions that an integration or AI agent needs.

The API root holds information like:

  • Whether the sandbox or live API served the request, and the API version.
  • How the request was authenticated.
  • The account that the caller is authenticated against.
  • The permissions granted to the caller.

Was this page helpful?