API Reference

List all tasks

Example request

curl 'https://api.impact.com/Advertisers/<AccountSID>/Programs/1000/Tasks' \
  -X GET \
  -u '<AccountSID>:<AuthToken>' \
  -H 'Accept: application/json'

Example response

{
  "@page": "1",
  ...,
  "Tasks": [
    {
      "Id": "3562529",
      "Reference": "",
      "Details": {
        "Summary": "Acme Rewards Card Update",
        "Description": "The Acme Rewards Card APR has changed, please update your ads to reflect this new value.",
        "Urgent": true,
        "State": "NEW",
        "Type": "COMPLIANCE",
        "SubtypeId": "",
        "SubtypeName": "",
        "ResolutionId": "",
        "ResolutionName": ""
      },
      "Attachments": [
        {
          "Id": "task_1223456_988957a0-e0ed-4f16-984b-f5a9259e6be7",
          "Filename": "acme_reward_card_details.pdf",
          "Location": "https://cdn.example.com/task_123456_988957a0-e0ed-4f16-984b-f5a9259e6be7.pdf"
        },
      ],
      "DueDate": "2021-08-31T04:00:00.000+0000",
      "AssigneeUser": {
        "Username": "Wile E. Coyote",
        "EmailAddress": "[email protected]"
      },
      "AssigneeAccount": "Acme Partners",
      "TotalActions": "0",
      "Actions": "",
      "TotalComments": "1",
      "Comments": [
        {
          "Id": "98765",
          "Comment": "I've updated our home page with the latest ads, see attached screenshot.",
          "Commenter": "Wile E. Coyote",
          "Attachments": [
            {
              "Id": "comment_987654_ccbef408-9312-440a-8a8a-6b58ce9c0492",
              "Filename": "coyote_partner_homepage.jpg",
              "Location": "https://cdn.impactradius-content.com/comment_987654_ccbef408-9312-440a-8a8a-6b58ce9c0492.jpg"
            }
          ]
        },
      ],
      "DateCreated": "2021-08-18T16:47:21.000+0000",
      "DateLastUpdated": "2021-08-18T22:45:42.000+0000",
      "CreatedBy": {
        "Username": "Acme.Road.Runner",
        "EmailAddress": "[email protected]"
      },
      "LastUpdatedBy": {
        "Username": "Acme.Road.Runner",
        "EmailAddress": "[email protected]"
      }
    },
    {
     ...
    }
  ]
}

Returns a list of existing tasks that have not been archived.

Parameters

DateLastUpdatedBefore optional

Only return tasks that have a DateLastUpdated value that is chronologically before the supplied value.

DateLastUpdatedAfter optional

Only return tasks that have a DateLastUpdated value that is chronologically after the supplied value.

Returns

Returns an array of tasks up to a limit dictated by @pagesize. Each entry in the array is a separate task. If no tasks meet the criteria, the resulting array will be empty. This request should never return an error.