API Reference

The REST reference in this site is backed by the OpenAPI spec at:

• /docs/public-api/docusaurus/docs/api-reference/openapi.yaml

This first pass covers:

• OAuth token issuance
• CORE client context
• numbers
• number search
• number update
• message send

How to use this reference

Use the reference in this order:

1. start with Getting Started if you have not completed a first successful send
2. use the authored docs for lifecycle and operational guidance
3. use the OpenAPI reference for exact request and response structure

The authored docs explain how the system behaves. The OpenAPI reference is the contract source for route shape, schema shape, and canonical examples.

Supplementary authored docs

The OpenAPI spec does not attempt to fully model every webhook contract in the first pass.

Use the authored docs alongside the REST reference for:

• webhook event families
• signing behavior
• retry/backoff behavior
• customer webhook delivery behavior and boundaries

Recommended companion pages:

• Webhooks Overview
• Signature Verification
• Event Lifecycle
• Idempotency and Retries
• Error Handling Playbook

Contract notes worth remembering

• sendFrom is a Red Cloud numberId, not an E.164 phone number
• POST /api/core/messages/send requires Idempotency-Key
• token issuance returns OAuth-style errors, not the CORE wrapper
• webhook contracts are documented in authored docs rather than fully modeled in the OpenAPI spec in this pass

Open the rendered reference

• REST API Reference
• Interactive OpenAPI Rendering