Skip to main content
Everything engineering teams need to integrate Offergrid. Start with the quickstart, then work from the reference for your role.
Base URL https://api.offergrid.io · Auth x-api-key: YOUR_TEAM_API_KEY · Version 1OpenAPI 3.x specsProvider · Reseller · Public · FullFor agentsagents.md briefing · llms.txt index · llms-full.txt · append .md to any docs URL for raw markdown

Getting Started

Quickstart

Your first authenticated call, start to finish

API Introduction

Base URL, roles, specs, and where to go next

Authentication

Issuing, rotating, and revoking keys; role behaviour; auth errors

Agent briefing

One page with everything needed to generate a correct integration

Shared behaviour

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

API conventions

List responses, identifiers, timestamps, money, and idempotency

Errors

Every status code, what causes it, and a retry-safe client

Rate limits

What is limited today, and what to build for

Versioning & changelog

What we promise not to break, and a dated record of what changed

Provider API

Provider API Reference

Every provider endpoint — offers, orders, markets, webhooks, brands

Provider API Integration

Step-by-step guide to integrating as a service provider

Provider Webhooks

Signed, real-time order events — payloads, verification, and delivery behaviour

Serviceability Integration

Expose one endpoint for address-level availability and live pricing

Reseller API

Reseller API Reference

Every reseller endpoint — catalog, availability, orders, links, customers

Reseller API Integration

Step-by-step guide to integrating as a reseller partner

Reseller Webhooks

Signed, real-time events for the orders your team placed

Checking Availability

Find every offer sellable at a specific service address

Public API

Public API Reference

Unauthenticated endpoints for shareable links and the consumer storefront

Common Integration Tasks

Creating Offers (Provider)

Create and publish service offers via API

Browsing Catalog (Reseller)

Search and filter available offers using the API

Receiving Orders (Provider)

Order webhooks and order data structure

Placing Orders (Reseller)

Submit orders programmatically via the API

Resources

Provider Documentation

Complete provider documentation and guides

Reseller Documentation

Complete reseller documentation and guides