Contracts

List All Contracts

get

Returns a list of contracts for a specific campaign, with options for filtering by date, status, and other attributes.

Path parameters

AccountSIDstringRequired

The unique identifier for the account.

CampaignIdintegerRequired

The ID of the campaign (program) to retrieve contracts from.

Query parameters

DateLastUpdatedBeforestring · date-timeOptional

Return contracts updated before a specific date and time.

DateLastUpdatedAfterstring · date-timeOptional

Return contracts updated after a specific date and time.

StartDateBeforestring · date-timeOptional

Return contracts that start before a specific date and time.

StartDateAfterstring · date-timeOptional

Return contracts that start after a specific date and time.

EndDateBeforestring · date-timeOptional

Return contracts that end before a specific date and time.

EndDateAfterstring · date-timeOptional

Return contracts that end after a specific date and time.

PartnerIdintegerOptional

Filter contracts for a specific partner.

SignatorystringOptional

Search for contracts by brand or partner signatory.

Statusstring · enumOptional

Filter contracts by status. Defaults to ACTIVE if not specified.

Possible values:

TemplateIdintegerOptional

Filter contracts by the source Template Terms ID.

Responses

200

A paginated list of contract objects.

application/json

get/Advertisers/{AccountSID}/Campaigns/{CampaignId}/Contracts

HTTPcURLJavaScriptPython

GET /Advertisers/{AccountSID}/Campaigns/{CampaignId}/Contracts HTTP/1.1
Host: api.impact.com
Accept: */*

200

A paginated list of contract objects.

{
  "Contracts": [
    {
      "Id": "S-7777777",
      "PartnerId": 10000,
      "PartnerValue1": "",
      "Status": "ACTIVE",
      "StartDate": "2026-01-20T00:00:00-08:00",
      "EndDate": "",
      "BrandSignatory": "Justin Case",
      "BrandSignatoryDate": "2026-01-19T23:51:01-08:00",
      "PartnerSignatory": "Partner Person",
      "PartnerSignatoryDate": "2026-01-19T23:51:01-08:00",
      "DateCreated": "2026-01-19T23:51:01-08:00",
      "DateLastUpdated": "2026-01-19T23:51:01-08:00",
      "TemplateTerms": {
        "TemplateId": 99999,
        "VersionId": "6",
        "Name": "ACME Public Terms",
        "Labels": [
          "text"
        ],
        "Currency": "USD",
        "EventPayouts": [
          {
            "EventTypeId": "18500",
            "EventTypeName": "Online Sale",
            "EventCategory": "SALE",
            "DefaultPayout": 10,
            "DefaultPayoutRate": "15",
            "PayoutLevel": "ITEM",
            "PayoutGroups": [
              {
                "Id": "ab12c3d4-5e6f-7g89-01h2-345ijk6lmn78",
                "Rank": "1",
                "Rules": [
                  {
                    "Variable": "CUSTOMER_COUNTRY",
                    "Operator": "IS",
                    "Values": [
                      "text"
                    ]
                  }
                ],
                "Payout": 1,
                "PayoutRate": "15",
                "Limits": [
                  {
                    "Type": "PAYOUT",
                    "Subtype": "SKU",
                    "Value": "45.0",
                    "LimitBy": "ITEM",
                    "Period": "DAY",
                    "WeekendOverrideValue": "500"
                  }
                ],
                "Tiers": [
                  {
                    "RevenueThreshold": "15.00",
                    "ActionThreshold": 1,
                    "ParentTier": 1,
                    "Payout": 1,
                    "PayoutRate": "60"
                  }
                ]
              }
            ],
            "PayoutAdjustments": [
              {
                "Id": "x234y567-8901-2z3a-4567-8b9012345c67",
                "Rules": [
                  {
                    "Variable": "CUSTOMER_COUNTRY",
                    "Operator": "IS",
                    "Values": [
                      "text"
                    ]
                  }
                ],
                "Direction": "INCREASE",
                "Amount": 1,
                "Rate": "15"
              }
            ],
            "PerformanceBonus": {
              "Type": "ALL_ACTIONS",
              "Basis": "REVENUE",
              "Period": "CALENDAR_MONTH",
              "Tiers": [
                {
                  "RevenueThreshold": "15.00",
                  "ActionThreshold": 1,
                  "ParentTier": 1,
                  "Payout": 1,
                  "PayoutRate": "60"
                }
              ]
            },
            "PayoutRestrictions": [
              {
                "Id": "8d9012ef-gh34-56i7-jk89-012345l67890",
                "Rules": [
                  {
                    "Variable": "CUSTOMER_COUNTRY",
                    "Operator": "IS",
                    "Values": [
                      "text"
                    ]
                  }
                ],
                "ZeroPayoutHideReport": "0"
              }
            ],
            "Limits": [
              {
                "Type": "PAYOUT",
                "Subtype": "SKU",
                "Value": "45.0",
                "LimitBy": "ITEM",
                "Period": "DAY",
                "WeekendOverrideValue": "500"
              }
            ],
            "Locking": {
              "Basis": "TRACKED",
              "Period": "MONTH",
              "MonthOffset": "1",
              "DayOffset": "0",
              "DayOfMonth": 1,
              "OpenEndedAutoLockingMode": "APPROVE",
              "MaxMonthsOpenEndedPeriod": 1
            },
            "PayoutScheduling": {
              "Basis": "LOCKED",
              "Period": "END_OF_MONTH",
              "MonthOffset": 1,
              "DayOffset": 1
            },
            "CreditPolicy": "LAST_REFERRER",
            "ValidReferrals": [
              {
                "Type": "CLICKS",
                "Window": "30",
                "WindowUnit": "DAY"
              }
            ]
          }
        ],
        "PromotionalTerms": [
          {
            "TermsName": "Custom Terms",
            "TermsType": "CUSTOM",
            "TermsContent": "text",
            "TermsPdfUri": "../folder"
          }
        ],
        "ChangeNotificationPeriod": 30,
        "ReturnPolicy": "ALWAYS_OK",
        "MaxReturnPercentage": 100,
        "ActionLimit": 1000,
        "ActionLimitPeriod": "MONTH",
        "SpendLimit": 10000,
        "SpendLimitPeriod": "MONTH",
        "MinEarningPerClick": 0.05,
        "ContractStartSlottingFee": 0,
        "FirstActionSlottingFee": 0,
        "MonthlySlottingFee": 0,
        "CustomCreativePayer": "ADVERTISER"
      },
      "PdfUri": "/Advertisers/<AccountSID>/Campaigns/1000/Contracts/S-7777777/Download",
      "Uri": "/Advertisers/<AccountSID>/Campaigns/1000/Contracts/S-7777777"
    }
  ]
}

Retrieve a Contract

get

Retrieves the details of a single, existing contract by its unique ID.

Path parameters

AccountSIDstringRequired

The unique identifier for the account.

CampaignIdintegerRequired

The ID of the campaign (program) the contract belongs to.

ContractIdstringRequired

The unique impact.com ID for the contract.

Responses

200

A single contract object.

application/json

IdstringOptional

The unique identifier for the contract.

Example: S-7777777

PartnerIdintegerOptional

The unique identifier of the partner the contract is with.

Example: 10000

PartnerValue1stringOptional

A custom value associated with the partner.

Statusstring · enumOptional

The current status of the contract.

Example: ACTIVEPossible values:

StartDatestring · date-timeOptional

The date and time the contract becomes active.

Example: 2026-01-20T00:00:00-08:00

EndDatestring · date-time · nullableOptional

The date and time the contract expires. Null for open-ended contracts.

BrandSignatorystringOptional

The name of the brand representative who signed the contract.

Example: Justin Case

BrandSignatoryDatestring · date-timeOptional

The date and time the brand signed the contract.

Example: 2026-01-19T23:51:01-08:00

PartnerSignatorystringOptional

The name of the partner representative who signed the contract.

Example: Partner Person

PartnerSignatoryDatestring · date-timeOptional

The date and time the partner signed the contract.

Example: 2026-01-19T23:51:01-08:00

DateCreatedstring · date-timeOptional

The date and time the contract was created.

Example: 2026-01-19T23:51:01-08:00

DateLastUpdatedstring · date-timeOptional

The date and time the contract was last updated.

Example: 2026-01-19T23:51:01-08:00

PdfUristring · uri-referenceOptional

The URI to download the contract as a PDF.

Example: /Advertisers/<AccountSID>/Campaigns/1000/Contracts/S-7777777/Download

Uristring · uri-referenceOptional

The unique reference to this contract in the impact.com API.

Example: /Advertisers/<AccountSID>/Campaigns/1000/Contracts/S-7777777

get/Advertisers/{AccountSID}/Campaigns/{CampaignId}/Contracts/{ContractId}

HTTPcURLJavaScriptPython

GET /Advertisers/{AccountSID}/Campaigns/{CampaignId}/Contracts/{ContractId} HTTP/1.1
Host: api.impact.com
Accept: */*

200

A single contract object.

{
  "Id": "S-7777777",
  "PartnerId": 10000,
  "PartnerValue1": "",
  "Status": "ACTIVE",
  "StartDate": "2026-01-20T00:00:00-08:00",
  "EndDate": "",
  "BrandSignatory": "Justin Case",
  "BrandSignatoryDate": "2026-01-19T23:51:01-08:00",
  "PartnerSignatory": "Partner Person",
  "PartnerSignatoryDate": "2026-01-19T23:51:01-08:00",
  "DateCreated": "2026-01-19T23:51:01-08:00",
  "DateLastUpdated": "2026-01-19T23:51:01-08:00",
  "TemplateTerms": {
    "TemplateId": 99999,
    "VersionId": "6",
    "Name": "ACME Public Terms",
    "Labels": [
      "text"
    ],
    "Currency": "USD",
    "EventPayouts": [
      {
        "EventTypeId": "18500",
        "EventTypeName": "Online Sale",
        "EventCategory": "SALE",
        "DefaultPayout": 10,
        "DefaultPayoutRate": "15",
        "PayoutLevel": "ITEM",
        "PayoutGroups": [
          {
            "Id": "ab12c3d4-5e6f-7g89-01h2-345ijk6lmn78",
            "Rank": "1",
            "Rules": [
              {
                "Variable": "CUSTOMER_COUNTRY",
                "Operator": "IS",
                "Values": [
                  "text"
                ]
              }
            ],
            "Payout": 1,
            "PayoutRate": "15",
            "Limits": [
              {
                "Type": "PAYOUT",
                "Subtype": "SKU",
                "Value": "45.0",
                "LimitBy": "ITEM",
                "Period": "DAY",
                "WeekendOverrideValue": "500"
              }
            ],
            "Tiers": [
              {
                "RevenueThreshold": "15.00",
                "ActionThreshold": 1,
                "ParentTier": 1,
                "Payout": 1,
                "PayoutRate": "60"
              }
            ]
          }
        ],
        "PayoutAdjustments": [
          {
            "Id": "x234y567-8901-2z3a-4567-8b9012345c67",
            "Rules": [
              {
                "Variable": "CUSTOMER_COUNTRY",
                "Operator": "IS",
                "Values": [
                  "text"
                ]
              }
            ],
            "Direction": "INCREASE",
            "Amount": 1,
            "Rate": "15"
          }
        ],
        "PerformanceBonus": {
          "Type": "ALL_ACTIONS",
          "Basis": "REVENUE",
          "Period": "CALENDAR_MONTH",
          "Tiers": [
            {
              "RevenueThreshold": "15.00",
              "ActionThreshold": 1,
              "ParentTier": 1,
              "Payout": 1,
              "PayoutRate": "60"
            }
          ]
        },
        "PayoutRestrictions": [
          {
            "Id": "8d9012ef-gh34-56i7-jk89-012345l67890",
            "Rules": [
              {
                "Variable": "CUSTOMER_COUNTRY",
                "Operator": "IS",
                "Values": [
                  "text"
                ]
              }
            ],
            "ZeroPayoutHideReport": "0"
          }
        ],
        "Limits": [
          {
            "Type": "PAYOUT",
            "Subtype": "SKU",
            "Value": "45.0",
            "LimitBy": "ITEM",
            "Period": "DAY",
            "WeekendOverrideValue": "500"
          }
        ],
        "Locking": {
          "Basis": "TRACKED",
          "Period": "MONTH",
          "MonthOffset": "1",
          "DayOffset": "0",
          "DayOfMonth": 1,
          "OpenEndedAutoLockingMode": "APPROVE",
          "MaxMonthsOpenEndedPeriod": 1
        },
        "PayoutScheduling": {
          "Basis": "LOCKED",
          "Period": "END_OF_MONTH",
          "MonthOffset": 1,
          "DayOffset": 1
        },
        "CreditPolicy": "LAST_REFERRER",
        "ValidReferrals": [
          {
            "Type": "CLICKS",
            "Window": "30",
            "WindowUnit": "DAY"
          }
        ]
      }
    ],
    "PromotionalTerms": [
      {
        "TermsName": "Custom Terms",
        "TermsType": "CUSTOM",
        "TermsContent": "text",
        "TermsPdfUri": "../folder"
      }
    ],
    "ChangeNotificationPeriod": 30,
    "ReturnPolicy": "ALWAYS_OK",
    "MaxReturnPercentage": 100,
    "ActionLimit": 1000,
    "ActionLimitPeriod": "MONTH",
    "SpendLimit": 10000,
    "SpendLimitPeriod": "MONTH",
    "MinEarningPerClick": 0.05,
    "ContractStartSlottingFee": 0,
    "FirstActionSlottingFee": 0,
    "MonthlySlottingFee": 0,
    "CustomCreativePayer": "ADVERTISER"
  },
  "PdfUri": "/Advertisers/<AccountSID>/Campaigns/1000/Contracts/S-7777777/Download",
  "Uri": "/Advertisers/<AccountSID>/Campaigns/1000/Contracts/S-7777777"
}