Oneserve Legacy API reference¶
The legacy Oneserve REST API is being retired in favour of the new Oneserve API. This site tells you three things: which legacy endpoints are deprecated, what replaces each one, and how to migrate.
Deprecation policy
A legacy endpoint is deprecated on the day the new API ships a replacement for it, and is switched off 12 months later. Endpoints with no replacement stay fully supported, with one narrow exception shown in the table below.
Timeline and notice policy¶
| Status | What that means for you |
|---|---|
| Replaced | Switched off 12 months after its deprecation date; the exact date is shown on the endpoint's page. Migrate before then. |
| No replacement | Fully supported and unaffected by any switch-off date. When a replacement ships, its own 12-month clock starts and this site is updated. |
| No usage observed | A small number of endpoints had no production calls in recent access logs. These may be retired early, even without a replacement; they are flagged on their pages and in the matrix Notes. If you use one, contact Oneserve support and it will stay supported for its full standard notice period. |
Where to start¶
- Read the migration guide: the important model differences and the recommended order of work.
- Find each legacy endpoint your integration calls in the category cards on the migration guide, or use the search bar.
- Check its status. Replaced: follow the link to the new endpoint and apply the migration notes. No replacement: no action needed yet.
Questions?¶
If you are unsure how a specific endpoint maps to the new API, or you depend on something that has no replacement yet, raise it with Oneserve support so it can feed into the migration roadmap.