> For the complete documentation index, see [llms.txt](https://docs.onside.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.onside.io/api/welcome-to-the-onside-api.md).

# Welcome to the Onside API

An introduction to the Onside API, covering authentication, key concepts, and where to find detailed endpoint references.

Welcome, developer! The Onside API provides programmatic access to manage your apps, automate workflows, and integrate Onside Console features directly into your own tools.

Whether you want to automate new app submissions, sync analytics data with your internal dashboards, or manage your app listings from your CI/CD pipeline, our REST API is here to help.

***

### Exploring the API

Our API is organized into logical sections based on functionality.

<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>Transactions Reporting API</strong></td><td>Use your payment gateway and tell us about your transactions.</td><td><a href="/api/transactions-reporting-api.md">Transactions Reporting API</a></td></tr><tr><td><strong>App Management API</strong></td><td>Coming Soon!</td><td></td></tr><tr><td><strong>Analytics API</strong></td><td>Coming Soon!</td><td></td></tr></tbody></table>

***


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.onside.io/api/welcome-to-the-onside-api.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.