Migrating from API v0

❗️

Please reach out to our team if you're still using API v0 and have any questions about making the switch to v1. See our changelog to keep track of all the great updates being made to v1.

📘

Key things to know

• API v1 uses a new URL.
• You'll need to generate new API tokens.
• API v1 is versioned with a mandatory "Accept-Version" header.

Recommended approach

• Read the Getting Started guide to get familiar with the new Runn API v1.
• For a detailed list of changes since v0 see the API v1 Beta Release notes.
• Browse the Runn API changelog to keep up with the latest improvements.
• The new API v1 Reference is the best place to get specific details on all endpoints.
• Utilise the API v1 utility endpoint to convert legacy ID's to the numeric format used in API v1
• Use the Test Account functionality to take a copy of your live account, then generate a test API token and review your updated integration before going live.

Tips

• If you're syncing data with Runn, be sure to check the new modifiedAfter filter available on many endpoints. See the API v1 Reference.

Decommissioning your old integration

• Your existing integration with API v0 tokens will continue to work against API v0 endpoints while you are migrating to API v1.
• Once you have verified your updated integration is working well you can revoke your API v0 tokens from the Settings > API screen.

Support

If you have any questions. You can reach us at [email protected]