​
Introduction to the Onsi API

The Onsi API provides a comprehensive set of endpoints for seamless interaction with the Onsi platform. With this API, you can easily search for members, send invitations, and update member details.

​
Authentication

To protect the privacy and security of our data, the Onsi API requires authentication for all requests. Include your API key in the x-api-key header to authenticate your requests.
To request an API key, please reach out to us.
Example: 
{
  "x-api-key": "your_api_key_here"
}

​
Response Codes

The Onsi API uses standard HTTP response codes to indicate the success or failure of an API request, see below to go to our Guide on Error handling.

Error Handling Guide

Read our in-depth guide on the errors returned by the Onsi API and how to handle them.

​
Data Format

All request and response bodies in the Onsi API are in JSON format. Make sure to include a Content-Type: application/json header in your requests and ensure that your JSON bodies are properly formatted. With this information, you’re ready to start exploring the full potential of the Onsi API. Enjoy building your integration!