Skip to main content

Getting Started

The Optimal Developer Documentation helps you build integrations with Optimal APIs. The first supported API is the Research Data API v1, which provides programmatic, read-only access to research activities and their participant, response, and insight data.

Production base URL​

Send Research Data API requests to:

https://api.optimalworkshop.com/api/research/v1

All requests use HTTPS and JSON.

Before you begin​

You need:

  • an Optimal account with access to the Research Data API;
  • integration client credentials issued from Optimal;
  • a confidential server-side application that can protect the client secret; and
  • an HTTP client that can make OAuth and JSON API requests.

Do not embed integration client secrets in browser code, mobile applications, or other public clients.

Next steps​

  1. Use your client credentials to request an OAuth access token with the research_read scope.
  2. Send the token with each API request as an Authorization: Bearer header.
  3. Choose a Research Data API v1 operation from the API reference.
  4. Follow pagination cursors until you have retrieved the complete collection.