The Optify platform offers a public REST API so your organization can read and update platform data from your own systems instead of working through the web app by hand. Typical uses include:
Exporting programs, engagements, and events into a data warehouse or BI tool for reporting
Creating users and engagements, and welcoming clients, automatically from an HRIS or CRM
Keeping engagement details in sync with your LMS or another system of record
Before you begin: request API access
The API is not turned on by default. Platform customers who want to use it need to request access by chatting with our team: open the chat widget in the bottom-right corner of the Optify platform and send us a message asking for API access for your provider. Once we have enabled it, we will share additional info on how to create your own API keys.
What you can do with the API
The API covers the core platform objects:
Users - create users, list and update them, and deactivate a user when they leave
Programs - list and update programs, including their metadata
Engagements - create engagements, list and update them, and welcome a client into their program
Events - list and update meetings, including their metadata
Questionnaires - list and update intake questionnaires and their responses
Each API key belongs to a single provider. Calls made with your key only ever see and change your own provider's data, never another provider's.
Authentication
Every request is authenticated with your API key, sent in the authorization header with the literal prefix api-key :
curl https://api.optify.io/me -H "authorization: api-key YOUR_API_KEY" -H "content-type: application/vnd.optify.APIKey+json;v=1"
A successful call returns a 200 and the key's details. If the key is missing you will see 401 Missing API Key, and if it is wrong you will see 403 Invalid API Key.
Once you are authenticated you can start calling the resources listed above. Request and response bodies use the content type shown for each endpoint in the documentation, for example application/vnd.optify.User+json;v=1 for users.
Treat your API key like a password. Store it in your own secret manager, never in client-side code or a public repository, and never share it in a support chat. If you believe a key has been exposed, contact us through the chat and we will help you replace it.
Listing, paging, and filtering
List endpoints return one page of results at a time along with page_number, results_per_page, total_pages, and total_results, so you can page through large data sets. By default a list returns up to 50 results per page; pass results_per_page to change that.
The full API documentation
The complete reference - every endpoint, every field, and example requests and responses - is available at Optify API Documentation.
A note on roles
The API works with the coach, client, and sponsor roles. The admin role cannot be granted through the API: requests that try to set an admin are rejected. Admin accounts are managed inside the platform.
Questions?
If you are unsure whether the API is right for your use case, or you need help getting your first request working, send us a message using the chat widget in the platform - we are happy to help.