Skip to content

Migrating from the legacy API to the new Oneserve API

This is the migration playbook: the important model differences, the recommended order of work, and the endpoint-by-endpoint category cards. You can also use the search bar to jump straight to an endpoint. For the deprecation timeline and notice policy, see the home page.

Important model differences

Job Events / OneCore Events

The legacy addEvent / jobEventsXml* family records and retrieves per-job audit-trail events (arrived on site, paused for parts, etc.). The new /v1/events endpoints are OneCore, Oneserve's event-driven subscription layer: they let your systems subscribe to event topics like job.created. The two are different concepts.

The direct replacement for recording an audit-trail event against a job is POST /v1/jobs/{id}/events. For integrations that polled the legacy event feeds, subscribe to OneCore events instead; see the events section of the new API documentation.

Authentication

Legacy auth has been replaced by a richer system: MFA, SSO, refresh tokens, session management. Most integrators will need a one-off rework of credential handling before any other migration becomes meaningful.

  1. Authentication first. The new bearer token authenticates calls to both APIs, so switching sign-in unblocks everything else. See the authentication migration guide.
  2. Then everything badged Replaced. Work through the category cards below; each endpoint page links straight to its replacement, with migration notes covering any behavioural differences.
  3. Nothing else. Endpoints without a replacement need no action yet.

Start with authentication

Browse by category

  • Authentication

    Login, sessions, MFA, SSO

    Fully replaced

  • Workflow

    Jobs, activities, events, notes

    16 of 29 endpoints replaced

  • Resource Scheduler

    Appointments, bulk booking, slots

    7 of 11 endpoints replaced

  • Contact

    Contacts, sites, locations, worklogs

    6 of 7 endpoints replaced

  • Document

    Upload and export

    1 of 3 endpoints replaced

  • Config

    Users, client groups

    1 of 3 endpoints replaced

  • Costs

    Job costing

    1 of 5 endpoints replaced

  • Asset Management

    Assets, surveys, conditions

    No replacements yet

  • Stock Management

    Parts, purchase orders, stock transactions

    No replacements yet