GET /work-requests

1 min

GET

https://api.cmp.optimizely.com/v3/work-requests

Experimental Get a list of work requests.

Query Parameters

created_bystring
Example
```
[
  "1265ca474ba987cc925164aa7",
  "606995f714ace404593cce4c"
]
```
Description
Unique identifier of the creator of the work requests. You can append multiple times, for example created_by=creator1&created_by=creator2.
statusstring
Example
```
[
  "Accepted",
  "Submitted"
]
```
Description
Status of a work request. You can append multiple times, for example status=Submitted&status=Declined
Allowed
SubmittedAcceptedCompletedDeclined
order_bystring
Example
due_date
Description
Ordering parameter of the work requests.
Allowed
prioritystatuscreated_atdue_date
order_asstring
Example
desc
Description
Sorting order of the work requests.
Allowed
ascdesc
template_idsstring[]
Example
```
[
  "1265ca474ba987cc925164aa7",
  "606995f714ace404593cce4c"
]
```
Description
Unique identifiers of the templates. You can append multiple times, for example template_ids=template1&template_ids=template2.
created_at__fromstring<date-time>
Example
2018-11-30T13:32:44Z
Description
Date and time as the lower limit to filter work requests by created_at, in ISO 8601 UTC format
Format
date-time
created_at__tostring<date-time>
Example
2018-12-31T23:59:59Z
Description
Date and time as the upper limit to filter work requests by created_at, in ISO 8601 UTC format
Format
date-time
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 work requests

object
- dataWorkRequestResponse[]required
  Description
  List of work requests
  - idstringrequired
    Example
    5fe4925ef8a9378056bf4e37
    Description
    Unique identifier of the work request
  - templateobjectrequired
    Description
    The template, based on the work request that was created
    - idstringrequired
      Example
      1265ca474ba987cc925164aa7
      Description
      Unique identifier of the template
    - titlestringrequired
      Example
      Sample template title
      Description
      Title of the template
    - linksobjectrequired
      Description
      Meta links
      - selfstringrequired
        Example
        https://api.cmp.optimizely.com/v3/templates/9119a313057e401189407116fcd3aa24
        Description
        URL of the template
  - reference_idstringrequired
    Example
    WRQ-23
    Description
    Reference identifier of the work request
  - assigneesobject[]required
    Description
    List of assigned users to the work request
    - idstringrequired
      Example
      6asdcnfnfdsfdsfd54sgfd54sf
      Description
      Unique identifier of the assignee
    - typestring<user | team>required
      Example
      user
      Description
      Type of the assignee
      Allowed
      userteam
    - full_namestringrequired
      Example
      John Doe
      Description
      Full name of the assignee
    - image_urlstringrequired
      Example
      https://images.cmp.optimizely.com/6a485f72ba424f9397c71ddf0cfb8f59
      Description
      URL of the profile picture of the assignee. null if the assignee has not provided an image
    - linksobjectrequired
      Description
      Meta links
      - selfstringrequired
        Example
        https://api.cmp.optimizely.com/v3/users/6asdcnfnfdsfdsfd54sgfd54sf
        Description
        URL of the assigned user
  - statusstring<Accepted | Declined | Submitted | Completed>required
    Example
    Accepted
    Description
    Current status of the work request
    Allowed
    AcceptedDeclinedSubmittedCompleted
  - prioritystring<Low | Medium | High>required
    Example
    Medium
    Description
    Priority of the work request
    Allowed
    LowMediumHigh
  - created_byobjectrequired
    Description
    Creator of the work request
    - idstringrequired
      Example
      6asdcnfnfdsfdsfd54sgfd54sf
      Description
      Unique identifier of the creator of the work request
    - linksobjectrequired
      Description
      Meta links
      - selfstringrequired
        Example
        https://api.cmp.optimizely.com/v3/users/6asdcnfnfdsfdsfd54sgfd54sf
        Description
        URL of the creator
  - created_atstring<date-time>required
    Example
    2022-04-30T06:00:00.000Z
    Description
    Date and time on which the work request was created, in ISO 8601 UTC format (2022-04-30T06:00
    .000Z)
    Format
    date-time
  - modified_atstring<date-time>required
    Example
    2022-04-30T08:00:00.000Z
    Description
    Date and time on which the work request was last modified, in ISO 8601 UTC format (2022-04-30T08:00
    .000Z)
    Format
    date-time
  - form_fieldsTextTypeFormFieldResponse[]required
    Description
    Populated form fields following the template
    - BaseFormFieldResponse
      - identifierstringrequired
        Example
        brief
        Description
        Identifier of the form field collected from the template form field
      - typestringrequired
        Example
        brief
        Description
        Type of the form field
      - valuesobject[]required
        Description
        Values of the form field
      - is_protectedboolean
        Description
        True when this form field is read-only and only organization admins can modify it. Absent or false for editable fields.
    - object
      - valuesstring[]
  - linksobjectrequired
    Description
    Meta links
    - selfstringrequired
      Example
      https://api.cmp.optimizely.com/v3/work-requests/5fe4925ef8a9378056bf4e37
      Description
      URL of the work request
    - commentsstringrequired
      Example
      https://api.cmp.optimizely.com/v3/work-requests/5fe4925ef8a9378056bf4e37/comments
      Description
      URL to create or get work request comments
    - attachmentsstringrequired
      Example
      https://api.cmp.optimizely.com/v3/work-requests/5fe4925ef8a9378056bf4e37/attachments
      Description
      URL to add attachments to work request
    - campaignsstringrequired
      Example
      https://api.cmp.optimizely.com/v3/work-requests/5fe4925ef8a9378056bf4e37/campaigns
      Description
      URL to create a campaign from the work request
    - tasksstringrequired
      Example
      https://api.cmp.optimizely.com/v3/work-requests/5fe4925ef8a9378056bf4e37/tasks
      Description
      URL to create a task from the work request
    - creative_assetsstringrequired
      Example
      https://api.cmp.optimizely.com/v3/work-requests/5fe4925ef8a9378056bf4e37/creative-assets
      Description
      URL to add creative assets to the work request
    - related_resourcesstringrequired
      Example
      https://api.cmp.optimizely.com/v3/work-requests/5fe4925ef8a9378056bf4e37/related-resources
      Description
      URL to get related resources
- 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/work-requests?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/work-requests?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/work-requests?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/work-requests?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/work-requests?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 work requests
{
  "data": [
    {
      "id": "5fe4925ef8a9378056bf4e37",
      "template": {
        "id": "1265ca474ba987cc925164aa7",
        "title": "Sample template title",
        "links": {
          "self": "https://api.cmp.optimizely.com/v3/templates/9119a313057e401189407116fcd3aa24"
        }
      },
      "reference_id": "WRQ-23",
      "assignees": [
        {
          "id": "6asdcnfnfdsfdsfd54sgfd54sf",
          "type": "user",
          "full_name": "John Doe",
          "image_url": "https://images.cmp.optimizely.com/6a485f72ba424f9397c71ddf0cfb8f59",
          "links": {
            "self": "https://api.cmp.optimizely.com/v3/users/6asdcnfnfdsfdsfd54sgfd54sf"
          }
        }
      ],
      "status": "Accepted",
      "priority": "Medium",
      "created_by": {
        "id": "6asdcnfnfdsfdsfd54sgfd54sf",
        "links": {
          "self": "https://api.cmp.optimizely.com/v3/users/6asdcnfnfdsfdsfd54sgfd54sf"
        }
      },
      "created_at": "2022-04-30T06:00:00.000Z",
      "modified_at": "2022-04-30T08:00:00.000Z",
      "form_fields": {},
      "links": {
        "self": "https://api.cmp.optimizely.com/v3/work-requests/5fe4925ef8a9378056bf4e37",
        "comments": "https://api.cmp.optimizely.com/v3/work-requests/5fe4925ef8a9378056bf4e37/comments",
        "attachments": "https://api.cmp.optimizely.com/v3/work-requests/5fe4925ef8a9378056bf4e37/attachments",
        "campaigns": "https://api.cmp.optimizely.com/v3/work-requests/5fe4925ef8a9378056bf4e37/campaigns",
        "tasks": "https://api.cmp.optimizely.com/v3/work-requests/5fe4925ef8a9378056bf4e37/tasks",
        "creative_assets": "https://api.cmp.optimizely.com/v3/work-requests/5fe4925ef8a9378056bf4e37/creative-assets",
        "related_resources": "https://api.cmp.optimizely.com/v3/work-requests/5fe4925ef8a9378056bf4e37/related-resources"
      }
    }
  ],
  "pagination": {}
}

401

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

403

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