GET /tasks

1 min

GET

https://api.cmp.optimizely.com/v3/tasks

Experimental Get a list of tasks.

Pick one style of date filter per request. Either use start_date and due_date, or use the __from and __to filters. A request that mixes the two styles returns a 400 error.

Query Parameters

search_keystring
Example
task 1
Description
Search for task title
campaignstring
Example
8n7f910o51b00b722o0418n30cie8211
Description
Campaign id of the tasks
workflowstring
Example
8n7f910o51b00b722o0418n30cie8211
Description
Workflow id of the tasks
milestonestring
Example
8n7f910o51b00b722o0418n30cie8211
Description
Milestone id of the tasks
start_datestring
Example
2022-08-24T00:00:00.000Z
Description
Warning: Deprecated
due_datestring
Example
2022-08-24T00:00:00.000Z
Description
Warning: Deprecated
start_date__fromstring<date-time>
Example
2022-08-24T00:00:00Z
Description
Date and time as the lower limit to filter tasks by their start date, in ISO 8601 UTC format
Format
date-time
start_date__tostring<date-time>
Example
2022-08-31T23:59:59Z
Description
Date and time as the upper limit to filter tasks by their start date, in ISO 8601 UTC format
Format
date-time
due_date__fromstring<date-time>
Example
2022-08-24T00:00:00Z
Description
Date and time as the lower limit to filter tasks by their due date, in ISO 8601 UTC format
Format
date-time
due_date__tostring<date-time>
Example
2022-08-31T23:59:59Z
Description
Date and time as the upper limit to filter tasks by their due date, in ISO 8601 UTC format
Format
date-time
statusstring[]
Example
```
[
  "In Progress",
  "Not Started"
]
```
Description
Filter tasks by status. Provide multiple statuses to filter tasks across multiple statuses.
offsetinteger
Example
5
Description
Starting index of results (zero indexed)
Default
0
Minimum
0
page_sizeinteger
Example
15
Description
Number of results to return per page
Default
10
Minimum
1
Maximum
100

Responses

200List of fetched tasks

object
- dataTaskListResponseItem[]required
  Description
  List of tasks
  - idstringrequired
    Example
    837f910551b00a722e0418830cee6612
    Description
    Unique identifier of the task
  - titlestringrequired
    Example
    The awesome task
    Description
    Title of the task
  - start_atstringrequired
    Example
    2024-06-01T06:00:00Z
    Description
    Start date of the task in ISO 8601 UTC format
  - due_atstringrequired
    Example
    2024-06-01T06:00:00Z
    Description
    Due date of the task in ISO 8601 UTC format
  - modified_atstringrequired
    Example
    2024-06-01T06:00:00Z
    Description
    Modified date of the task in ISO 8601 UTC format
  - reference_idstringrequired
    Example
    TSK-1589
    Description
    Reference identifier of the task
  - is_completedbooleanrequired
    Description
    Whether the task is completed or not
  - is_archivedbooleanrequired
    Description
    Whether the task is archived or not
  - campaign_idstringrequired
    Example
    8n7f910o51b00b722o0418n30cie8211
    Description
    Unique identifier of the campaign
  - workflow_idstringrequired
    Example
    8n7f910o51b00b722o0418n30cie8211
    Description
    Unique identifier of the workflow
  - milestone_idstringrequired
    Example
    8n7f910o51b00b722o0418n30cie8211
    Description
    Unique identifier of the milestone
  - statusstring<Archived | Completed | Overdue | Not Started | In Progress | On Hold>required
    Example
    Not Started
    Description
    Current status of the task
    Allowed
    ArchivedCompletedOverdueNot StartedIn ProgressOn Hold
  - linksobjectrequired
    Description
    Meta links
    - selfstringrequired
      Example
      https://api.cmp.optimizely.com/v3/tasks/5d7f910551b00a722e0418830cee5534
      Description
      URL of the task
    - campaignstringrequired
      Example
      https://api.cmp.optimizely.com/v3/campaigns/2e7f9107351b00a722e0412230cee5534
      Description
      URL of the campaign that the task is associated with
    - workflowstringrequired
      Example
      https://api.cmp.optimizely.com/v3/workflows/63f1c2b675be4132854d2741
      Description
      URL of the workflow the task
    - milestonestringrequired
      Example
      https://api.cmp.optimizely.com/v3/milestones/63f1c2b675be4132854d2741
      Description
      URL of the milestone that the task is associated with
    - web_urlsobjectrequired
      Description
      Web URLs
      - selfstringrequired
        Example
        https://cmp.optimizely.com/cloud/taskv3/5c52cc153db27d0e5141146f
        Description
        Web URL of the task
- paginationobjectrequired
  - Pagination
    - nextstringrequired
      Example
      https://api.cmp.optimizely.com/<some-path-to-next-page>?offset=10&page_size=10
      Description
      URL to the next page
    - previousstringrequired
      Description
      URL to the previous page
  - object
    - nextstring
      Example
      https://api.cmp.optimizely.com/v3/tasks?offset=10&page_size=10

401Authorization error

Error
Example
```
{
  "message": "Unauthorized"
}
```
Description
Error payload
- messagestringrequired
  Example
  Not found
  Description
  Message describing the error
- errorsmap<string, string>
  Description
  Additional information

403Permission error

Error
Example
```
{
  "message": "You do not have the permission to perform this operation"
}
```
Description
Error payload
- messagestringrequired
  Example
  Not found
  Description
  Message describing the error
- errorsmap<string, string>
  Description
  Additional information

curl

curl --request GET \
     --url 'https://api.cmp.optimizely.com/v3/tasks?offset=5&page_size=10' \
     --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?offset=5&page_size=10", 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?offset=5&page_size=10")

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?offset=5&page_size=10"

payload = {}
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

200

// List of fetched tasks
{
  "data": [
    {
      "id": "837f910551b00a722e0418830cee6612",
      "title": "The awesome task",
      "start_at": "2024-06-01T06:00:00Z",
      "due_at": "2024-06-01T06:00:00Z",
      "modified_at": "2024-06-01T06:00:00Z",
      "reference_id": "TSK-1589",
      "is_completed": false,
      "is_archived": false,
      "campaign_id": "8n7f910o51b00b722o0418n30cie8211",
      "workflow_id": "8n7f910o51b00b722o0418n30cie8211",
      "milestone_id": "8n7f910o51b00b722o0418n30cie8211",
      "status": "Not Started",
      "links": {
        "self": "https://api.cmp.optimizely.com/v3/tasks/5d7f910551b00a722e0418830cee5534",
        "campaign": "https://api.cmp.optimizely.com/v3/campaigns/2e7f9107351b00a722e0412230cee5534",
        "workflow": "https://api.cmp.optimizely.com/v3/workflows/63f1c2b675be4132854d2741",
        "milestone": "https://api.cmp.optimizely.com/v3/milestones/63f1c2b675be4132854d2741",
        "web_urls": {
          "self": "https://cmp.optimizely.com/cloud/taskv3/5c52cc153db27d0e5141146f"
        }
      }
    }
  ],
  "pagination": {}
}

401

// Authorization error
{
  "message": "Not found",
  "errors": ""
}

403

// Permission error
{
  "message": "Not found",
  "errors": ""
}