Musement API

The Musement API Developer Hub

Welcome to the Musement API developer hub. You'll find comprehensive guides and documentation to help you start working with Musement API as quickly as possible, as well as support if you get stuck. Let's jump right in!

Subscribe to the Musement API Docs Newsletter

API Reference

Swagger definition

Guides    API Reference

Versioning

TLDR;: always use the X-Musement-Version header.

When you start a new project that uses Musement API, set the X-Musement-Version header to the latest version available. This assures that the model in the response will be stable with time.

Attention!

You can use Musement API without specifing the specific version you want.
You will be served the latest available version.
If you follow this road you're subect to breaking changes that may be introduced in future releases. So your application will probably break.

When a new version is released, you can check the documentation and choose to upgrade your header or remain with your version. You can also specify different versions for different calls, but we discourage this practice.

Calling an endpoint setting X-Musement-Version to 3.3.0

curl -X GET \
  '{{api_base_url}}/activities/0f54ca01-2046-11e7-9cc9-06a7e332783f'
  -H 'X-Musement-Version: 3.3.0'

Versioning


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.