GET /settings
1 min
GET
https://api.cmp.optimizely.com/v3/settings
Responses
200
- Settings
- resourcesSettingsResourcesrequiredDescription
- labelsSettingsLabelGroup[]requiredDescription
- has_single_valuebooleanrequiredExampleDescription
- label_typestringrequiredExampleDescription
- labelsSettingsLabelGroupLabel[]requiredDescription
- namestringrequiredExampleDescription
- colorstringrequiredExampleDescription
- custom_fieldsSettingsCustomFieldrequiredDescription
- currencyCurrencyCustomField[]requiredDescription
- labelstringrequiredExampleDescription
- decimal_placesintegerrequiredExampleDescription
- currency_codestringrequiredExampleDescriptionDefaultUSD
- has_thousand_separatorbooleanrequiredDescriptionDefaultfalse
- numberNumberCustomField[]requiredDescription
- labelstringrequiredExampleDescription
- decimal_placesintegerrequiredExampleDescription
- has_thousand_separatorbooleanrequiredDescriptionDefaultfalse
- percentagePercentageCustomField[]requiredDescription
- labelstringrequiredExampleDescription
- decimal_placesintegerrequiredExampleDescription
- checkboxMultipleOptionCustomField[]requiredDescription
- labelstringrequiredExampleDescription
- choicesstring[]requiredExample
[ "choice1", "choice2" ]
Description
- dropdownMultipleOptionCustomField[]requiredDescription
- labelstringrequiredExampleDescription
- choicesstring[]requiredExample
[ "choice1", "choice2" ]
Description
- multichoiceMultipleOptionCustomField[]requiredDescription
- labelstringrequiredExampleDescription
- choicesstring[]requiredExample
[ "choice1", "choice2" ]
Description
- multi_select_dropdownMultipleOptionCustomField[]requiredDescription
- labelstringrequiredExampleDescription
- choicesstring[]requiredExample
[ "choice1", "choice2" ]
Description
- dateLabelOnlyCustomField[]requiredDescription
- labelstringrequiredExampleDescription
- imageLabelOnlyCustomField[]requiredDescription
- labelstringrequiredExampleDescription
- richtextLabelOnlyCustomField[]requiredDescription
- labelstringrequiredExampleDescription
- stringLabelOnlyCustomField[]requiredDescription
- labelstringrequiredExampleDescription
- textareaLabelOnlyCustomField[]requiredDescription
- labelstringrequiredExampleDescription
- videoLabelOnlyCustomField[]requiredDescription
- labelstringrequiredExampleDescription
- workflowsSettingsWorkflow[]requiredDescription
- is_flexible_workflowbooleanrequiredDescription
- is_not_pushed_to_library_by_defaultbooleanrequiredDescription
- is_released_as_assetbooleanrequiredDescription
- namestringrequiredExampleDescription
- labelsWorkflowLabel[]requiredDescription
- default_valuestring[]requiredExample
[ "label1", "label2" ]
Description - is_requiredbooleanrequiredExampleDescription
- label_typestringrequiredExampleDescription
- is_required_at_task_creationbooleanrequiredDescription
- custom_fieldsWorkflowCustomfield[]requiredDescription
- is_requiredbooleanrequiredDescription
- fieldstringrequiredExampleDescription
- default_valuestring[]requiredExample
[ "choice1", "choice2" ]
DescriptionDefault - typestringrequiredExampleDescription
- default_channelsWorkflowChannel[]requiredDescription
- display_namestringrequiredExampleDescription
- typestringrequiredExampleDescription
- blacklisted_channelsWorkflowChannel[]requiredDescription
- display_namestringrequiredExampleDescription
- typestringrequiredExampleDescription
- stepsWorkflowStep[]requiredDescription
- labelstringrequiredExampleDescription
- substepsWorkflowSubStep[]requiredDescription
- actionsstring[]requiredExample
[ "findContent", "writeEditSocialPost" ]
Description - labelstringrequiredExampleDescription
- external_sub_step_configobjectDescription
- is_user_interaction_allowedbooleanDescriptionDefaultfalse
- is_externalbooleanrequiredDescriptionDefaultfalse
- external_systemstringrequiredDescription
- descriptionstringrequiredExampleDescription
- descriptionstringrequiredExampleDescription
- durationintegerrequiredExampleDescription
- descriptionstringrequiredExampleDescription
- templatesSettingsTemplate[]requiredDescription
- namestringrequiredExampleDescription
- descriptionstringrequiredExampleDescription
- public_descriptionstringrequiredExampleDescription
- form_fieldsFormField[]requiredDescription
- field_typestringrequiredExampleDescription
- helpstringrequiredExampleDescription
- is_requiredbooleanrequiredDescription
- logic_rulesLogicRule[]requiredDescription
- actionLogicRuleActionrequiredDescription
- target_fieldLogicRuleTargetFieldrequiredDescription
- Max depth limit reached
- typestringrequiredExampleDescription
- valuesstring[]requiredExample
[ "a choice" ]
Description
- conditionLogicRuleConditionrequiredDescription
- operatorstringrequiredExampleDescription
- valuesstring[]requiredExample
[ "choice1" ]
Description
- sort_orderintegerrequiredDescription
- identifierstringrequiredExampleDescription
- custom_field_typestringrequiredExampleDescription
- sectionsSection[]requiredDescription
- labelstringrequiredExampleDescription
- idstringrequiredExampleDescription
- instructionsInstruction[]requiredDescription
- descriptionstringrequiredExampleDescription
- idstringrequiredExampleDescription
- typesstring[]requiredExample
[ "campaign_brief", "task_brief", "work_request" ]
Description
- appsSettingsApp[]requiredDescription
- namestringrequiredExampleDescription
- descriptionstringrequiredExampleDescription
- homepage_urlstringrequiredExampleDescription
- authorization_callback_urlsstring[]requiredExample
[ "https://example1.com", "https://example2.com" ]
Description - expose_emailbooleanrequiredExampleDescription
- envstringrequiredExampleDescription
- webhooksSettingsWebhook[]requiredDescription
- namestringrequiredExampleDescription
- descriptionstringrequiredExampleDescription
- callback_urlstringrequiredExampleDescription
- secretstringrequiredExampleDescription
- event_namesstring[]requiredExample
[ "asset_added", "asset_removed" ]
Description
- routing_rulesSettingsRoutingRule[]requiredDescription
- namestringrequiredExampleDescription
- rulesobject[]requiredDescription
- field_typestringrequiredExampleDescription
- identifierstringrequiredExampleDescription
- operatorstringrequiredExampleDescription
- valuestring[]requiredExample
[ "value1", "value2" ]
Description - unitstring<days | weeks | months | years | >requiredExampleDescriptionAlloweddaysweeksmonthsyearsnull
- custom_field_typestringrequiredExampleDescription
- watchersstring[]requiredExample
[ "[email protected]" ]
Description - descriptionstringrequiredExampleDescription
- template_namestringrequiredExampleDescription
401
- ErrorExample
{ "message": "Unauthorized" }Description- messagestringrequiredExampleDescription
- errorsmap<string, string>Description
403
- ErrorExample
{ "message": "You do not have the permission to perform this operation" }Description- messagestringrequiredExampleDescription
- errorsmap<string, string>Description
curl
curl --request GET \
--url https://api.cmp.optimizely.com/v3/settings \
--header 'accept: application/json'javascript
var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");
var requestOptions = {
method: 'GET',
headers: myHeaders,
redirect: 'follow'
};
fetch("https://api.cmp.optimizely.com/v3/settings", requestOptions)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));ruby
require "uri"
require "json"
require "net/http"
url = URI("https://api.cmp.optimizely.com/v3/settings")
https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true
request = Net::HTTP::Get.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
response = https.request(request)
puts response.read_body
python
import requests
import json
url = "https://api.cmp.optimizely.com/v3/settings"
payload = {}
headers = {
'accept': 'application/json',
'content-type': 'application/json'
}
response = requests.request("GET", url, headers=headers, data=payload)
print(response.text)
200
// Fetched settings
{
"resources": {
"labels": [
{
"has_single_value": true,
"label_type": "Content Pillar",
"labels": [
{
"name": "Pillar1",
"color": "#4ECFD5"
}
]
}
],
"custom_fields": {
"currency": [
{
"label": "A Currency Custom Field",
"decimal_places": 1,
"currency_code": "USD",
"has_thousand_separator": false
}
],
"number": [
{
"label": "A Number Custom Field",
"decimal_places": 1,
"has_thousand_separator": false
}
],
"percentage": [
{
"label": "A Percentage Custom Field",
"decimal_places": 1
}
],
"checkbox": [
{
"label": "A custom field with choice",
"choices": [
"choice1"
]
}
],
"dropdown": [
{
"label": "A custom field with choice",
"choices": [
"choice1"
]
}
],
"multichoice": [
{
"label": "A custom field with choice",
"choices": [
"choice1"
]
}
],
"multi_select_dropdown": [
{
"label": "A custom field with choice",
"choices": [
"choice1"
]
}
],
"date": [
{
"label": "A Custom Field"
}
],
"image": [
{
"label": "A Custom Field"
}
],
"richtext": [
{
"label": "A Custom Field"
}
],
"string": [
{
"label": "A Custom Field"
}
],
"textarea": [
{
"label": "A Custom Field"
}
],
"video": [
{
"label": "A Custom Field"
}
]
},
"workflows": [
{
"is_flexible_workflow": false,
"is_not_pushed_to_library_by_default": false,
"is_released_as_asset": false,
"name": "A Workflow",
"labels": [
{
"default_value": [
"label1"
],
"is_required": true,
"label_type": "Content Pillar",
"is_required_at_task_creation": false
}
],
"custom_fields": [
{
"is_required": false,
"field": "exampleCustomField",
"default_value": [
"choice1"
],
"type": "equal"
}
],
"default_channels": [
{
"display_name": "exampleChannel",
"type": "twitter"
}
],
"blacklisted_channels": [
{
"display_name": "exampleChannel",
"type": "twitter"
}
],
"steps": [
{
"label": "Step 1",
"substeps": [
{
"actions": [
"findContent"
],
"label": "Substep 1",
"external_sub_step_config": {
"is_user_interaction_allowed": false
},
"is_external": false,
"external_system": "",
"description": "This is a substep description"
}
],
"description": "This is a dummy example",
"duration": 1
}
],
"description": "Sample description"
}
],
"templates": [
{
"name": "Template 1",
"description": "Template description",
"public_description": "Template public description",
"form_fields": [
{
"field_type": "custom_field",
"help": "This is a helper text",
"is_required": false,
"logic_rules": [
{
"action": {
"target_field": {
"": ""
},
"type": "jump_to",
"values": [
"a choice"
]
},
"condition": {
"operator": "equal",
"values": [
"choice1"
]
}
}
],
"sort_order": 0,
"identifier": "SingleChoice1",
"custom_field_type": "multichoice"
}
],
"sections": [
{
"label": "Test section",
"id": "9ec506f480dbc2d5f6919168ae448c41"
}
],
"instructions": [
{
"description": "Test instruction description",
"id": "9ec506f480dbc2d5f6919168ae448c40"
}
],
"types": [
"campaign_brief"
]
}
],
"apps": [
{
"name": "App 1",
"description": "Sample description",
"homepage_url": "https://example1.com",
"authorization_callback_urls": [
"https://example1.com"
],
"expose_email": true,
"env": "production"
}
],
"webhooks": [
{
"name": "Webhook 1",
"description": "Sample description",
"callback_url": "https://exampledomain.com",
"secret": "secret121",
"event_names": [
"asset_added"
]
}
],
"routing_rules": [
{
"name": "example Routing Rule",
"rules": [
{
"field_type": "customField",
"identifier": "exampleCustomField1",
"operator": "equal",
"value": [
"value1"
],
"unit": "days",
"custom_field_type": "multichoice"
}
],
"watchers": [
"[email protected]"
],
"description": "Sample routing rule description",
"template_name": "Sample template name"
}
]
}
}401
// Authorization error
{
"message": "Not found",
"errors": ""
}403
// Permission error
{
"message": "Not found",
"errors": ""
}