Skip to main content
Pin your API version once and your integration keeps the same contract when Fanvue ships a new one. Two separate settings control it. The X-Fanvue-API-Version date header selects behaviour, and the URL prefix, /v1/ or none, selects the current or previous resource shapes. Read this before your first production deploy, and again when a response starts carrying deprecation headers. The two axes move independently, so keep sending X-Fanvue-API-Version: 2025-06-26 when you move a path to /v1.

​
Version header

Send X-Fanvue-API-Version on every request. The current version is 2025-06-26.
A request without the header is served as 2025-06-26, the default, and only a value the API doesn’t recognise returns 400. Send the header anyway. The default moves when a new version becomes current, and a request that names its version keeps its contract through that change.

​
URL versions and channels

/v1 is the current URL version. It evolves additively, so new fields and new endpoints can appear, but no field, parameter or envelope on /v1 changes shape. A breaking change goes to the next URL version instead. The unversioned paths are the previous version, v0, and they keep working. Moving to v1 maps each unversioned path to its /v1 replacement. A resource reaches /v1 only once every list it serves is cursor-paginated, so no /v1 endpoint accepts page. App Store endpoints (/apps/*) have no /v1 form because their lists still page with page and size. Account health is split: the self-scoped /account-health and /account-health/flagged-media exist only on the previous version, while the creator-scoped /v1/creators/{creatorUserUuid}/account-health routes exist on both. The OpenAPI document is served per URL version:

​
Deprecation headers

A response served on a deprecated date version carries three headers. Alert on them in your HTTP client so a sunset never surprises you.
The request still succeeds. The headers tell you the version is on its way out and which version replaces it.

​
Version errors

A version the API does not recognise returns 400:
A version that has passed its sunset date returns 410:
On a 410, change your X-Fanvue-API-Version header to nextVersion and review the changelog for the differences. Retrying with the same version, or falling back to no header, doesn’t restore the old contract, because the request is served on the current version either way. Error responses lists both version errors with the API’s other error bodies.

​
Reading the reference on either URL version

The API reference documents both URL versions. The selector in the top bar, next to the logo, switches the whole reference between v1 and v0, and it opens on v1. The selector is part of the address, so a link always opens the version it was copied from. v1 pages sit under /v1/, as in /v1/api-reference/overview, and v0 pages keep the unprefixed paths they have always had, as in /api-reference/overview.