Skip to main content
The Offergrid API is a B2B marketplace API connecting service providers with reseller partners, streamlining the distribution and sale of essential services like internet and electricity.

​
Quick facts

​
Your first request

A 200 with a JSON array means you are connected and authenticated. A 401 means the key or header is wrong; a 403 means the key is fine but your team’s role does not cover that endpoint. See Errors.

​
What you can do

Which half of the API you use depends on your team’s role. The role is carried by the API key — there is nothing else to configure.

Provider API

Publish and manage service offers, define market coverage, receive and fulfill orders, and register webhooks.

Reseller API

Browse the catalog, check what is available at a service address, place orders for customers, and track fulfillment.

Public API

Unauthenticated endpoints powering shareable reseller links and the consumer storefront. No API key.

Agent briefing

A single page with everything needed to generate a correct integration.
Hybrid teams hold both roles and reach every endpoint with the same key.

​
Before you build

Four pages that will save you a debugging session each:

Authentication

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

API conventions

List responses, identifiers, timestamps, money, and idempotency

Errors

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

Versioning

What we promise not to break, and how deprecations work

​
Local development

https://api.offergrid.io is the only Offergrid-hosted environment — there is no separate sandbox host, and no test-mode key. If you want an environment to experiment against, run the API locally from the monorepo; it listens on http://localhost:3000 by default and speaks the same contract as production.
Because there is no sandbox, requests against api.offergrid.io are real: orders you create are real orders, and they notify real providers. Use a dedicated team for integration testing, and delete test data when you are done.

​
Getting an API key

Sign in at offergrid.io, then Settings → API Keys → Generate New Key. The key is shown once — store it in a secrets manager or environment variable immediately.
Keep your API key server-side. Never put it in client-side code, a mobile binary, or a repository. Treat it like a password.