# Get Started with Limio's API

Limio exposes a set of REST APIs that give you programmatic access to every commerce operation — submitting orders, reading the catalog, managing subscriptions, triggering checkout sessions, and more.

{% hint style="info" %}
The complete API reference with request/response schemas, parameters, and examples is at [docs.limio.com/api](https://docs.limio.com/api).
{% endhint %}

## What developers use Limio's APIs for

| Use case                               | How                                                                                                                                                                                                                                                   |
| -------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Headless pricing & checkout**        | Build custom pricing pages or checkout flows outside the Limio Page Builder — serve offers, collect payments, and submit orders from any front-end                                                                                                    |
| **Self-service portals**               | Let customers manage their own subscriptions, change plans, update payment methods, or cancel — all driven by API calls from your portal                                                                                                              |
| **Assisted & partner checkout**        | Initiate checkout sessions on behalf of customers — call-centre agents, sales reps, or channel partners selling through a business portal                                                                                                             |
| **Feed catalog data to other systems** | Pull offers, pricing, and product configuration into your CMS, data warehouse, mobile app, or AI agent                                                                                                                                                |
| **Abandoned cart recovery**            | Retrieve abandoned baskets, generate recovery links, and trigger re-engagement campaigns with promo codes attached                                                                                                                                    |
| **Programmatic catalog management**    | Create, update, or query offers and products at scale — useful for bulk pricing changes, demo setup, or automated catalog maintenance. See also the [Limio MCP Server](https://docs.limio.com/ai/mcp-server/setup) for AI-assisted catalog operations |
| **Bulk promo code creation**           | Generate and manage promotional codes programmatically for campaigns, partnerships, or customer win-back flows                                                                                                                                        |
| **Subscription queries**               | Query active subscriptions, statuses, and history from downstream systems — power dashboards, support tooling, or entitlement checks                                                                                                                  |
| **Partner management**                 | Manage partner relationships, enable partners to place orders, and track partner-originated transactions                                                                                                                                              |
| **Monitor builds & deployments**       | Track the status of shop builds and [custom component](/developers/custom-components/custom-components.md) deployments programmatically                                                                                                               |

## APIs at a glance

| API                                                                           | What it does                                                                                  |
| ----------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
| [Checkout API](https://docs.limio.com/api/checkout-api)                       | Create and manage checkout sessions from any channel                                          |
| [Orders API](https://docs.limio.com/api/orders-api)                           | Preview and submit orders — new subscriptions, changes, cancellations, payment updates, gifts |
| [Catalog API](https://docs.limio.com/api/catalog-api)                         | Read offers, pricing, products, pages, and campaign configuration                             |
| [Objects API](https://docs.limio.com/api/objects-api)                         | Query subscriptions, customers, and other record types                                        |
| [Build & Publish API](https://docs.limio.com/api/build-and-publish-api)       | Trigger shop builds and publish deployments                                                   |
| [Journeys API](https://docs.limio.com/api/journeys-api)                       | Create and manage customer journeys                                                           |
| [Session API](https://docs.limio.com/api/session-api)                         | Session-scoped endpoints for authenticated end-users                                          |
| [Integrations API](https://docs.limio.com/api/integrations-api)               | Connect external systems                                                                      |
| [Promo Codes API](https://docs.limio.com/api/promo-codes-api)                 | Validate and apply promotional codes                                                          |
| [External Identities API](https://docs.limio.com/api/external-identities-api) | Link multiple user identities to the same customer                                            |
| [Abandoned Basket API](https://docs.limio.com/api/abandoned-basket-api)       | Retrieve and act on abandoned checkout sessions                                               |

## Authentication

All APIs require an **OAuth Bearer Token**. This is the standard authentication method for all integrations.

Some Catalog API endpoints accept a publishable API key for read-only access. However, Limio is in the process of moving all endpoints to OAuth Bearer Token. If you are planning a new integration and need to use a publishable API key, please [contact Limio](mailto:support@limio.com).

[Set up authentication](/developers/api-documentation/authentication-overview.md)

## Next steps

* [Authentication overview](/developers/api-documentation/authentication-overview.md) — get your credentials and make your first authenticated request
* [Webhooks](/developers/webhooks/overview.md) — listen for commerce events
* [Limio SDK](/developers/limio-sdk/getting-started.md) — build custom front-end components


---

# Agent Instructions: Querying This Documentation

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

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.limio.com/developers/api-documentation/api.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.
