URL and Versioning

Base URL

The base URL for accessing the API is:

https://app.surveysphere.co.uk/api/

This URL serves as the root for all API requests. Every endpoint described in this documentation will be appended to this base URL.

API Versioning

To ensure backward compatibility and smooth integration of new features, all endpoints include a version number in their URL. This versioning approach allows clients to specify which version of the API they are interacting with and ensures that any breaking changes can be isolated to new versions of the API.

Current Version

All current endpoints are prefixed with /v1/, indicating that they are part of version 1 of the API.

Example:

https://app.surveysphere.co.uk/api/v1/{endpoint}

Here, {endpoint} represents the specific resource or action you wish to interact with.

Future Versioning

If there are breaking changes or major updates to the API in the future, a new version, such as /v2/, will be introduced. This allows existing clients to continue using the /v1/ endpoints without disruption while providing access to new features and improvements through the /v2/ endpoints.

Example of a future version:

https://app.surveysphere.co.uk/api/v2/{endpoint}

By using versioning in the API URL, we ensure that you have full control over when to upgrade to a new version, allowing your application to continue functioning with the version it was developed against.