> ## Documentation Index
> Fetch the complete documentation index at: https://offergrid.io/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# API Documentation

> Complete API reference and integration guides for engineering teams

Everything engineering teams need to integrate Offergrid. Start with the
quickstart, then work from the reference for your role.

<Info>
  **Base URL** `https://api.offergrid.io`  ·  **Auth** `x-api-key: YOUR_TEAM_API_KEY`  ·  **Version** 1

  **OpenAPI 3.x specs** — [Provider](/docs/openapi/openapi-provider.json) ·
  [Reseller](/docs/openapi/openapi-reseller.json) ·
  [Public](/docs/openapi/openapi-public.json) ·
  [Full](/docs/openapi/openapi.json)

  **For agents** — [agents.md briefing](/docs/agents) ·
  [llms.txt index](https://offergrid.io/docs/llms.txt) ·
  [llms-full.txt](https://offergrid.io/docs/llms-full.txt) ·
  append `.md` to any docs URL for raw markdown
</Info>

## Getting Started

<CardGroup cols={2}>
  <Card title="Quickstart" icon="rocket" href="/docs/quickstart">
    Your first authenticated call, start to finish
  </Card>

  <Card title="API Introduction" icon="book" href="/docs/api-reference/introduction">
    Base URL, roles, specs, and where to go next
  </Card>

  <Card title="Authentication" icon="key" href="/docs/api-reference/authentication">
    Issuing, rotating, and revoking keys; role behaviour; auth errors
  </Card>

  <Card title="Agent briefing" icon="robot" href="/docs/agents">
    One page with everything needed to generate a correct integration
  </Card>
</CardGroup>

## Shared behaviour

The rules every endpoint follows. Reading these first is the difference between
a one-hour integration and a one-day one.

<CardGroup cols={2}>
  <Card title="API conventions" icon="list-check" href="/docs/api-reference/conventions">
    List responses, identifiers, timestamps, money, and idempotency
  </Card>

  <Card title="Errors" icon="triangle-exclamation" href="/docs/api-reference/errors">
    Every status code, what causes it, and a retry-safe client
  </Card>

  <Card title="Rate limits" icon="gauge-high" href="/docs/api-reference/rate-limits">
    What is limited today, and what to build for
  </Card>

  <Card title="Versioning & changelog" icon="code-branch" href="/docs/api-reference/versioning">
    What we promise not to break, and a dated record of what changed
  </Card>
</CardGroup>

## Provider API

<CardGroup cols={2}>
  <Card title="Provider API Reference" icon="book-open" href="/docs/api-reference/provider">
    Every provider endpoint — offers, orders, markets, webhooks, brands
  </Card>

  <Card title="Provider API Integration" icon="plug" href="/docs/providers/api-integration">
    Step-by-step guide to integrating as a service provider
  </Card>

  <Card title="Provider Webhooks" icon="bell" href="/docs/providers/webhooks">
    Signed, real-time order events — payloads, verification, and delivery behaviour
  </Card>

  <Card title="Serviceability Integration" icon="map-location-dot" href="/docs/providers/serviceability-integration">
    Expose one endpoint for address-level availability and live pricing
  </Card>
</CardGroup>

## Reseller API

<CardGroup cols={2}>
  <Card title="Reseller API Reference" icon="book-open" href="/docs/api-reference/reseller">
    Every reseller endpoint — catalog, availability, orders, links, customers
  </Card>

  <Card title="Reseller API Integration" icon="plug" href="/docs/resellers/api-integration">
    Step-by-step guide to integrating as a reseller partner
  </Card>

  <Card title="Reseller Webhooks" icon="bell" href="/docs/resellers/webhooks">
    Signed, real-time events for the orders your team placed
  </Card>

  <Card title="Checking Availability" icon="location-crosshairs" href="/docs/resellers/checking-availability">
    Find every offer sellable at a specific service address
  </Card>
</CardGroup>

## Public API

<CardGroup cols={2}>
  <Card title="Public API Reference" icon="globe" href="/docs/api-reference/public">
    Unauthenticated endpoints for shareable links and the consumer storefront
  </Card>
</CardGroup>

## Common Integration Tasks

<CardGroup cols={2}>
  <Card title="Creating Offers (Provider)" icon="plus" href="/docs/providers/creating-offers">
    Create and publish service offers via API
  </Card>

  <Card title="Browsing Catalog (Reseller)" icon="magnifying-glass" href="/docs/resellers/browsing-catalog">
    Search and filter available offers using the API
  </Card>

  <Card title="Receiving Orders (Provider)" icon="inbox" href="/docs/providers/receiving-orders">
    Order webhooks and order data structure
  </Card>

  <Card title="Placing Orders (Reseller)" icon="cart-plus" href="/docs/resellers/creating-orders">
    Submit orders programmatically via the API
  </Card>
</CardGroup>

## Resources

<CardGroup cols={2}>
  <Card title="Provider Documentation" icon="building" href="/docs/provider-documentation">
    Complete provider documentation and guides
  </Card>

  <Card title="Reseller Documentation" icon="handshake" href="/docs/reseller-documentation">
    Complete reseller documentation and guides
  </Card>
</CardGroup>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.