Osmosis - API Documentation

Introduction

You can access your data via our simple RESTful API. We are still adding new resources to this API so be careful. The main goal of this API is to connect with other applications so your data can be exchanged based on your preferences.

Access and Authentication

Each of your requests must include the query string "key". The value must be your API key found on your Settings page.

The API URL is:

https://www.getosmosis.com/api/resource/method — (i.e https://www.getosmosis.com/api/Activities/Push)

Resources

Activities

API	Description
GET api/Activities/Recent	Get a stream of all your recent activities (last 7 days).
POST api/Activities/Push	No documentation available.

Agreements

API	Description
GET api/Agreements/Draft	Get a list of draft proposal
GET api/Agreements/Sent	Get a list of sent proposal
GET api/Agreements/Accepted	Get a list of accepted proposal
GET api/Agreements/Declined	Get a list of declined proposal
GET api/Agreements/SampleVerdicts	Return a sample list of Agreement Verdict
POST api/Agreements/Create	No documentation available.
GET api/Agreements/SampleViewedAlerts	Return a sample list of Proposal Viewed

Clients

API	Description
POST api/Clients/Create	Create a new client.
GET api/Clients/Fetch	Get a list of all your clients.
GET api/Clients/Get/{id}	Get a specific client.
PUT api/Clients/Update/{id}	Update a client.
DELETE api/Clients/Delete/{id}	Permanently delete a clients and all of their related assets (questionaires, agreements, etc).

Questionnaires

API	Description
GET api/Questionnaires/Draft	Get the questionnaires tagged as Draft
POST api/Questionnaires/Create	Create a new questionnaire for a client.
POST api/Questionnaires/Send	Create and send a new questionnaire for a client.

Zapier

API	Description
POST api/Zapier/Subscribe	Create a new Zapier event subscription
POST api/Zapier/UnSubscribe	Remove a Zapier subscription.