Tasks

List all tasks

get

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

Authorizations

basicAuth

AuthorizationstringRequired

Path parameters

AccountSIDstringRequired

The unique identifier for the account.

ProgramIdintegerRequired

The ID of the program to retrieve tasks from.

Query parameters

DateLastUpdatedBeforestring · date-timeOptional

Return tasks last updated before this date (ISO 8601).

DateLastUpdatedAfterstring · date-timeOptional

Return tasks last updated after this date (ISO 8601).

Responses

200

A list of task objects.

application/json

get/Advertisers/{AccountSID}/Programs/{ProgramId}/Tasks

HTTPcURLJavaScriptPython

GET /Advertisers/{AccountSID}/Programs/{ProgramId}/Tasks HTTP/1.1
Host: api.impact.com
Authorization: Basic username:password
Accept: */*

200

A list of task objects.

{
  "Tasks": [
    {
      "Id": "3562529",
      "Reference": {
        "PartnerId": 2552842,
        "PartnerValue1": "vip",
        "PartnerValue2": "north-america",
        "PartnerValue3": "tennis"
      },
      "Details": {
        "Summary": "Acme Rewards Card Update",
        "Description": "Partner needs help with tracking setup.",
        "Urgent": false,
        "State": "NEW",
        "Type": "COMPLIANCE",
        "SubtypeId": 1001,
        "SubtypeName": "Tracking Issue",
        "ResolutionId": "5",
        "ResolutionName": "Resolved"
      },
      "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": "[e-mail]"
      },
      "AssigneeAccount": "Acme Partners",
      "TotalActions": 0,
      "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": "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"
            }
          ],
          "DateCreated": "2026-01-15T10:00:00-08:00"
        }
      ],
      "DateCreated": "2021-08-18T16:47:21.000+0000",
      "DateLastUpdated": "2021-08-18T22:45:42.000+0000",
      "CreatedBy": {
        "Username": "Wile E. Coyote",
        "EmailAddress": "[e-mail]"
      },
      "LastUpdatedBy": {
        "Username": "Wile E. Coyote",
        "EmailAddress": "[e-mail]"
      }
    }
  ]
}

Retrieve a task

get

Retrieves the full object details of an existing task.

Authorizations

basicAuth

AuthorizationstringRequired

Path parameters

AccountSIDstringRequired

The unique identifier for the account.

ProgramIdintegerRequired

The ID of the program the task belongs to.

TaskIdintegerRequired

The unique identifier for the task.

Responses

200

A single task object.

application/json

IdstringOptional

The unique identifier for the task.

Example: 3562529

DueDatestring · date-timeOptional

Date and time at which the task is due (ISO 8601).

Example: 2021-08-31T04:00:00.000+0000

AssigneeAccountstringOptional

Name of the partner account that the task is assigned to.

Example: Acme Partners

TotalActionsintegerOptional

Total number of actions that have been recorded for this task.

Example: 0

TotalCommentsintegerOptional

Total number of comments that have been recorded for this task.

Example: 1

DateCreatedstring · date-timeOptional

The date and time the task was created.

Example: 2021-08-18T16:47:21.000+0000

DateLastUpdatedstring · date-timeOptional

The date and time the task was last updated.

Example: 2021-08-18T22:45:42.000+0000

get/Advertisers/{AccountSID}/Programs/{ProgramId}/Tasks/{TaskId}

HTTPcURLJavaScriptPython

GET /Advertisers/{AccountSID}/Programs/{ProgramId}/Tasks/{TaskId} HTTP/1.1
Host: api.impact.com
Authorization: Basic username:password
Accept: */*

200

A single task object.

{
  "Id": "3562529",
  "Reference": {
    "PartnerId": 2552842,
    "PartnerValue1": "vip",
    "PartnerValue2": "north-america",
    "PartnerValue3": "tennis"
  },
  "Details": {
    "Summary": "Acme Rewards Card Update",
    "Description": "Partner needs help with tracking setup.",
    "Urgent": false,
    "State": "NEW",
    "Type": "COMPLIANCE",
    "SubtypeId": 1001,
    "SubtypeName": "Tracking Issue",
    "ResolutionId": "5",
    "ResolutionName": "Resolved"
  },
  "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": "[e-mail]"
  },
  "AssigneeAccount": "Acme Partners",
  "TotalActions": 0,
  "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": "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"
        }
      ],
      "DateCreated": "2026-01-15T10:00:00-08:00"
    }
  ],
  "DateCreated": "2021-08-18T16:47:21.000+0000",
  "DateLastUpdated": "2021-08-18T22:45:42.000+0000",
  "CreatedBy": {
    "Username": "Wile E. Coyote",
    "EmailAddress": "[e-mail]"
  },
  "LastUpdatedBy": {
    "Username": "Wile E. Coyote",
    "EmailAddress": "[e-mail]"
  }
}