API stability
What being in the reference promises, and how change is handled.
The API reference is a curated surface, not a mirror of everything the platform can do. An endpoint appears there when we're prepared to keep it working for you.
What "documented" promises
Every endpoint in the reference is one we intend to keep stable: the fields its requests accept and its responses return are commitments, and your integration can rely on them.
Two kinds of change still happen freely, because neither can break a well-behaved integration:
- New endpoints join the reference as they mature.
- New optional fields may appear in responses at any time. Parse what you need and ignore what you don't recognize — never reject a response for containing a field you haven't seen before.
Breaking changes
Removing a field, renaming one, changing a type, or retiring an endpoint is a breaking change. When one is unavoidable, we announce it ahead of time so there's a window to adapt before anything stops working.
Everything else
The platform has internal endpoints beyond the reference. They can change or disappear without notice — if you've found one that isn't documented, treat it as off-limits, and tell us (through Support in your dashboard) what you needed it for so we can consider adding a supported version.