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

Get API root

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

GET/

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)

dataobjectrequired
Represents the API root entity, with information about the Paddle API and the caller making the request.
apiobjectrequired
Information about the Paddle API serving this request.
namestringrequired
Human-readable name of the API.
versionstringrequired
Version of the API serving this request.
environmentstringrequired
Environment that the API is serving the request in.
Values
  • production
    Live production environment.
  • sandbox
    Sandbox testing environment.
documentation_urlstring (uri)required
Link to the API reference documentation.
callerobjectrequired
Information about the caller making this request.
auth_typestring | nullrequired
Authentication method used for this request. null when the request doesn't have valid credentials.
Values
  • 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.
accountobject | nullrequired
Account that the caller is authenticated against. null when the request doesn't have valid credentials.
idstringrequired
Unique Paddle ID for this account, prefixed with slr_.
namestringrequired
Name of this account.
permissionsarrayrequired
Names of the permissions granted to the caller, for example transaction.read. Empty when the request doesn't have valid credentials.
metaobjectrequired
Information about this response.
request_idstringrequired
Example: b15ec92e-8688-40d4-a04d-f44cbec93355
Unique ID for the request relating to this response. Provide this when contacting Paddle support about a specific request.
Response
{
  "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"
  }
}

Was this page helpful?