Skip to main content

API

This is the internal documentation for the read-oriented API surface.

The docs are private to the team. "API" means the API returns registry data that is safe for approved external consumption. It does not mean the docs or credentials are public.

Reference​

Use the OpenAPI reference:

  • API Reference: /api/reference

Rules​

  • Do not expose private phone numbers or email addresses.
  • Prefer stable handles for filters and enum values.
  • Keep read behavior backward compatible when possible.
  • Document breaking changes before sharing them with partners.

Current Contract​

The public reference is generated from:

docs/api/openapi.yaml

If endpoint behavior changes, update the route, tests, and this OpenAPI file in the same change.