# OpenAPI specification

> The public BroadNet API spec as OpenAPI 3.1 at /developers/openapi.yaml (JSON at /developers/openapi.json): 329 paths and 376 operations across 8 channels, with internal examples removed. Import it into Postman, Insomnia or Swagger UI, or generate a client for any language with openapi-generator. The official TypeScript SDK (@broadnet/cpaas-sdk) is generated from the BroadNet OpenAPI specification.

- Canonical URL: https://www.broadnet.me/developers/openapi
- Language: en
- Last updated: 2026-10-21
- Publisher: BroadNet (https://www.broadnet.me)

The BroadNet API as one OpenAPI 3.1 file: 329 paths and 376 operations across eight channels. It is a public copy with internal examples removed. Import it into Postman, Insomnia or Swagger UI, or generate a client in any language. The official TypeScript SDK (@broadnet/cpaas-sdk) is generated from the BroadNet OpenAPI specification.

> **Download** YAML: /developers/openapi.yaml · JSON: /developers/openapi.json

## Examples

### fetch the spec and generate a client

```bash
curl -O https://www.broadnet.me/developers/openapi.yaml

# Generate a Python client
npx @openapitools/openapi-generator-cli generate \
  -i openapi.yaml -g python -o broadnet-python

# Or a Go client
npx @openapitools/openapi-generator-cli generate \
  -i openapi.yaml -g go -o broadnet-go
```

OpenAPI 3.1 · 329 paths / 376 operations across 8 channels · public copy with internal examples removed