Skip to main content

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.

Choose Your Role

Offergrid serves two distinct user types. Select the path that matches your role:

I'm a Provider

Service providers offering internet, TV, security, energy, or insurance services

I'm a Reseller

Resellers helping customers find and purchase services

Quick Setup (Both Roles)

1. Create Your Account

1

Sign up

Visit offergrid.io and click Sign Up
2

Choose your role

Select Provider or Reseller based on your business
3

Complete profile

Fill in your company information and contact details
4

Get verified

Complete verification (typically takes 1-2 business days)

2. Generate API Key

1

Go to settings

Navigate to SettingsAPI Keys in your dashboard
2

Generate key

Click Generate New API Key
3

Save securely

Copy the key immediately and store it in environment variables
export OFFERGRID_API_KEY="your-api-key-here"
You won’t be able to see this key again!

3. Make Your First API Call

Test your API key with a simple request:
# Providers: List your offers
curl -X GET https://api.offergrid.io/provider/offers \
  -H "x-api-key: YOUR_API_KEY"

# Resellers: Browse catalog
curl -X GET https://api.offergrid.io/reseller/catalog \
  -H "x-api-key: YOUR_API_KEY"

Provider Quick Start

Create Your First Offer

curl -X POST https://api.offergrid.io/provider/offers \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "High-Speed Internet 1000 Mbps",
    "category": "internet",
    "status": "active",
    "monthlyPrice": 59.99,
    "description": "Blazing fast fiber internet",
    "keyFeatures": ["1000 Mbps download", "Unlimited data"]
  }'

View Incoming Orders

curl -X GET https://api.offergrid.io/provider/orders \
  -H "x-api-key: YOUR_API_KEY"

Next Steps for Providers

Provider Guide

Complete provider onboarding checklist

Creating Offers

Learn how to create service offerings

Order Fulfillment

Manage incoming orders

Provider API

API integration guide

Reseller Quick Start

Browse Available Services

curl -X GET "https://api.offergrid.io/reseller/catalog?category=internet&zipCode=94102" \
  -H "x-api-key: YOUR_API_KEY"

Place Your First Order

curl -X POST https://api.offergrid.io/reseller/orders \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "items": [{ "offerId": "off-123-abc" }],
    "customerInfo": {
      "fullName": "John Doe",
      "email": "john@example.com",
      "phone": "+1-555-123-4567"
    },
    "serviceAddress": {
      "street": "123 Main St",
      "city": "San Francisco",
      "state": "CA",
      "zipCode": "94102",
      "country": "US"
    }
  }'

Track Orders

curl -X GET https://api.offergrid.io/reseller/orders \
  -H "x-api-key: YOUR_API_KEY"

Next Steps for Resellers

Reseller Guide

Complete reseller onboarding checklist

Browsing Catalog

Find services for your customers

Placing Orders

Learn how to place orders

Reseller API

API integration guide

Common Questions

Account verification typically takes 1-2 business days. You’ll receive an email when your account is approved.
Yes! Some teams have hybrid access and can use both provider and reseller endpoints with the same API key.
Go to SettingsAPI Keys in your dashboard. If you lost your key, revoke it and generate a new one.
  • Burst: 100 requests per minute
  • Sustained: 10,000 requests per hour
Yes, create offers with status: "draft" to test without making them visible. Work with support to create test orders.

Additional Resources

How It Works

Platform overview and workflows

Authentication

API authentication guide

API Reference

Complete API documentation

Need Help?

Contact Support

Questions? Reach out to our team at support@offergrid.io