GET /tasks/{id}
1 min
GET
https://api.cmp.optimizely.com/v3/tasks/{id}
Path Parameters
- idstringrequiredExampleDescription
Responses
200
- TaskResponse
- idstringrequiredExampleDescription
- titlestringrequiredExampleDescription
- start_atstring<date-time>requiredExampleDescriptionFormatdate-time
- due_atstring<date-time>requiredExampleDescriptionFormatdate-time
- is_completedbooleanrequiredDescription
- is_archivedbooleanrequiredDescription
- statusstring<Archived | Completed | Overdue | Not Started | In Progress | On Hold>requiredExampleDescriptionAllowedArchivedCompletedOverdueNot StartedIn ProgressOn Hold
- reference_idstringrequiredExampleDescription
- workflow_idstringExampleDescription
- campaign_idstringrequiredExampleDescription
- milestone_idstringrequiredExampleDescription
- modified_atstringrequiredExampleDescription
- labelsResourceLabelResponse[]requiredDescription
- groupobjectrequiredDescription
- idstringrequiredExampleDescription
- namestringrequiredExampleDescription
- valuesobject[]requiredDescription
- idstringrequiredExampleDescription
- namestringrequiredExampleDescription
- stepsTaskStep[]requiredDescription
- idstringrequiredExampleDescription
- titlestringrequiredExampleDescription
- is_completedbooleanrequiredDescription
- descriptionstringrequiredExampleDescription
- due_atstring<date-time>requiredExampleDescriptionFormatdate-time
- sub_stepsTaskSubStep[]requiredDescription
- idstringrequiredExampleDescription
- titlestringrequiredExampleDescription
- assignee_idstringrequiredExampleDescription
- assignee_typestring<user | team>requiredExampleDescriptionAlloweduserteam
- is_completedbooleanrequiredDescription
- is_in_progressbooleanrequiredDescription
- is_skippedbooleanrequiredDescription
- is_externalbooleanrequiredExampleDescription
- linksobjectrequiredDescription
- selfstringrequiredExampleDescription
- taskstringrequiredExampleDescription
- external_workstringrequiredExampleDescription
- assigneestringExampleDescription
- linksobjectrequiredDescription
- selfstringrequiredExampleDescription
- assetsstringrequiredExampleDescription
- attachmentsstringrequiredExampleDescription
- briefstringrequiredExampleDescription
- campaignstringrequiredExampleDescription
- custom_fieldsstringrequiredExampleDescription
- milestonestringrequiredExampleDescription
- web_urlsobjectrequiredDescription
- selfstringrequiredExampleDescription
- briefstringrequiredExampleDescription
400
- ErrorExample
{ "message": "Unsupported arguments: a,b,c" }Description- messagestringrequiredExampleDescription
- errorsmap<string, string>Description
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
404
- ErrorExample
{ "message": "Resource not found" }Description- messagestringrequiredExampleDescription
- errorsmap<string, string>Description
curl
curl --request GET \
--url https://api.cmp.optimizely.com/v3/tasks/{id} \
--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/tasks/{id}", 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/tasks/{id}")
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/tasks/{id}"
payload = {}
headers = {
'accept': 'application/json',
'content-type': 'application/json'
}
response = requests.request("GET", url, headers=headers, data=payload)
print(response.text)
200
// Fetched task
{
"id": "5d7f910551b00a722e0418830cee5534",
"title": "Awesome Task",
"start_at": "2019-10-06T13:15:30Z",
"due_at": "2020-10-06T13:15:30Z",
"is_completed": false,
"is_archived": false,
"status": "Not Started",
"reference_id": "TSK-123",
"workflow_id": "8q7f910551b00a722e0418830cee6612",
"campaign_id": "8n7f910o51b00b722o0418n30cie8211",
"milestone_id": "8n7f910o51b00b722o0418n30cie8211",
"modified_at": "2024-06-01T06:00:00Z",
"labels": [
{
"group": {
"id": "2467e583a60e23fda2b89db81a453cd2",
"name": "Content Format"
},
"values": [
{
"id": "71c378f3fee3d822759d1bdc2aab628c",
"name": "Photos"
}
]
}
],
"steps": [
{
"id": "6d7f910551b00a722e0418830cee5564",
"title": "Sample step",
"is_completed": false,
"description": "Description of the step",
"due_at": "2020-10-06T13:15:30Z",
"sub_steps": [
{
"id": "9c7f910551b00a722e0418830cee2564",
"title": "Sample step",
"assignee_id": "5fdf31d57f0d0e362e2b5908",
"assignee_type": "user",
"is_completed": false,
"is_in_progress": false,
"is_skipped": false,
"is_external": true,
"links": {
"self": "https://api.cmp.optimizely.com/v3/tasks/5d7f910551b00a722e0418830cee5534/steps/6d7f910551b00a722e0418830cee5564/sub-steps/9c7f910551b00a722e0418830cee2564",
"task": "https://api.cmp.optimizely.com/v3/tasks/5d7f910551b00a722e0418830cee5534",
"external_work": "https://api.cmp.optimizely.com/v3/tasks/5d7f910551b00a722e0418830cee5534/steps/6d7f910551b00a722e0418830cee5564/sub-steps/9c7f910551b00a722e0418830cee2564/external-work",
"assignee": "https://api.cmp.optimizely.com/v3/users/5fdf31d57f0d0e362e2b5908"
}
}
]
}
],
"links": {
"self": "https://api.cmp.optimizely.com/v3/tasks/5d7f910551b00a722e0418830cee5534",
"assets": "https://api.cmp.optimizely.com/v3/tasks/5d7f910551b00a722e0418830cee5534/assets",
"attachments": "https://api.cmp.optimizely.com/v3/tasks/5d7f910551b00a722e0418830cee5534/attachments",
"brief": "https://api.cmp.optimizely.com/v3/tasks/5d7f910551b00a722e0418830cee5534/brief",
"campaign": "https://api.cmp.optimizely.com/v3/campaigns/2e7f9107351b00a722e0412230cee5534",
"custom_fields": "https://api.cmp.optimizely.com/v3/tasks/5d7f910551b00a722e0418830cee5534/custom-fields",
"milestone": "https://api.cmp.optimizely.com/v3/milestones/63f1c2b675be4132854d2741",
"web_urls": {
"self": "https://cmp.optimizely.com/cloud/taskv3/5c52cc153db27d0e5141146f",
"brief": "https://cmp.optimizely.com/cloud/taskv3/5c52cc153db27d0e5141146f?activeTab=brief"
}
}
}400
// Client error
{
"message": "Not found",
"errors": ""
}401
// Authorization error
{
"message": "Not found",
"errors": ""
}403
// Permission error
{
"message": "Not found",
"errors": ""
}404
// Not found error
{
"message": "Not found",
"errors": ""
}