Foam Partner API

Programmatic access to Foam's ISP platform for partner integrations.

API Documentation

Interactive API explorer with request examples and schema definitions.

OpenAPI Specification

Download the OpenAPI 3.1 spec for code generation and tooling.

Health Check

Check API status and connected services health.

Quick Start

1. Get your API key from your partner dashboard

curl -H "X-API-Key: pk_live_your_key" \
  https://api.foaminternet.com/api/v1/customers

API Capabilities

Customers

Create and manage customer accounts

Subscriptions

Manage service subscriptions

Provisioning

Request and track service setup

Serviceability

Check address coverage

Network

Status, outages, maintenance

Billing

Usage, invoices, balance

Tickets

Support ticket management

Webhooks

Real-time event notifications