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 for an organization, or for a workspace that is not in an organization, with Research Data API access enabled;
- 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.
What an access token can read
A Research API application belongs to one organization, or to one workspace that is not in an organization.
An organization application returns research activities from every workspace in that organization.
A workspace application returns research activities from that workspace only. Each activity includes
workspace_id, the identifier of the workspace that owns it.
See Authorization to create credentials.
Next steps
- Use your client credentials to request an OAuth access token with the
research_readscope. - Send the token with each API request as an
Authorization: Bearerheader. - Choose a Research Data API v1 operation from the API reference.
- Follow pagination cursors until you have retrieved the complete collection.