Check out the REST API migration guide if you are looking to migrate from Optimizely Classic to Optimizely X.

The v2 API is created to give you programmatic access to all your objects in Optimizely X. You can use the v2 API to read Optimizely Classic data, but to write to Optimizely Classic you will have to use the v1 API. Full Stack, Mobile, and OTT are not currently supported.

The v2 API is designed to give easy access to all the resources in your Optimizely X projects through a REST interface. Our API is designed to mirror the functionality of the Optimizely UI as close as possible. To do so, the endpoints have predictable, resource-oriented URLs. All the endpoints are defined using the OpenAPI Specification. With the OpenAPI Specification we guarantee that the documentation below is always up to date and that it is easy to create API clients in any programming language using the Swagger Generator. It is also possible to use any off-the-shelf HTTP client to make requests directly. The API returns JSON in the body of responses.

The preferred method of authenticating with the API is using OAuth 2.0, but to make our API easily explorable we have implemented Personal tokens. Personal tokens have replaced the tokens used by our v1 API.

If there is no value set for a field (the value is undefined) the field will not appear in the JSON response.

We have documented the most important API conventions:

If you have any questions, you can ask the developer community, or you can submit a ticket to the developer support team. We'll be happy to assist you.


Looking for endpoints for DCP (Dynamic Customer Profiles)?

Use the v1 REST API to configure DCP Services, Tables (datasources), and attributes. You can also read and write customer profiles, or get and create aliases using the v1 REST API.

Currently, all DCP REST APIs make use of only classic tokens for authorization. They do not accept personal-tokens to authorize api requests.

Don't worry! Even though they are configured with v1 REST APIs, any DCP services, datasource, attributes and profiles will still be accessible in Optimizely X.