API Quickstart

In this section, you'll find a step-by-step guide to quickly start using the API.

Prerequisites

List any prerequisites or dependencies that users need to have in place before they can start using the API.

Partner of MoveToHappiness
Production API Key

Authentication

Before getting started with our API, you will have to retrieve your API Key. Please contact your customer success representative or support@movetohappiness.com. You will be given an API Key in the form of a GUID. Once you have retrieved the API Key, you are able to use our API.Explain how to authenticate with the API, including obtaining API keys or tokens.

The API will authenticate your key via the X-API-KEY header of HTTP Requests.

Making Your First Request

Below is an example request to help you verify that your API Key is functioning properly.

GET /api/endpoint HTTP/1.1
Host: api.example.com
Headers: X-API-KEY: 00000000-0000-0000-0000-000000000000

Response Handling

API Responses will always be returned as JSON objects.

08 April 2025