Retrieves the object of an existing contract. You need to pass the unique impact.com campaign Id and contract Id values that were returned when listing contracts.
You can also use this endpoint to retrieve details on the contract’s Creator, Performance, or Product Boost campaigns.
Parameters
No parameters.
Returns
Returns a contract object if a valid identifier is provided. Returns an error for invalid identifiers.
Example Request
curl 'https://api.impact.com/Advertisers/<AccountSID>/Campaigns/1000/Contracts/S-7777777' \
-X GET \
-u '<AccountSID>:<AuthToken>' \
-H 'Accept: application/json'
Example Response
{
"Id": "S-7777777",
"PartnerId": "10000",
"PartnerValue1": "",
"Status": "ACTIVE",
"StartDate": "2021-01-20T00:00:00-08:00",
"EndDate": "",
"BrandSignatory": "Justin Case",
"BrandSignatoryDate": "2021-01-19T23:51:01-08:00",
"PartnerSignatory": "Partner Person",
"PartnerSignatoryDate": "2021-01-19T23:51:01-08:00",
"DateCreated": "2021-01-19T23:51:01-08:00",
"DateLastUpdated": "2021-01-19T23:51:01-08:00",
"TemplateTerms": {
"TemplateId": "99999",
"VersionId": "000006",
"Name": "ACME Public Terms",
"Labels": [
"HighestPercent"
],
"Currency": "USD",
"EventPayouts": [
{
"EventTypeId": "18500",
"EventTypeName": "Online Sale",
"EventCategory": "SALE",
"DefaultPayoutRate": "15",
"PayoutLevel": "ITEM",
"PayoutGroups": [
{
"Id": "ab12c3d4-5e6f-7g89-01h2-345ijk6lmn78",
"Rank": "1",
"Rules": [
{
"Variable": "CUSTOMER_COUNTRY",
"Operator": "IS",
"Values": [
"USA"
]
}
],
"PayoutRate": "15",
"Limits": [
{
"Type": "PAYOUT",
"Value": "45.0",
"LimitBy": "ITEM",
"Period": "DAY"
}
]
},
{
"Id": "90opqrs1-2t34-5678-9012-345u67v890w1",
"Rank": "2",
"Rules": [
{
"Variable": "ITEM_DISCOUNT",
"Operator": "IS",
"Values": [
"60"
]
}
],
"Payout": "15.00"
}
],
"PayoutAdjustments": [
{
"Id": "x234y567-8901-2z3a-4567-8b9012345c67",
"Rules": [
{
"Variable": "CUSTOMER_STATUS",
"Operator": "IS",
"Values": [
"FREQUENT"
]
}
],
"Direction": "INCREASE",
"Rate": "15"
}
],
"PerformanceBonus": {
"Type": "ALL_ACTIONS",
"Basis": "REVENUE",
"Period": "CALENDAR_MONTH",
"Tiers": [
{
"RevenueThreshold": "15.00",
"PayoutRate": "60"
}
]
},
"PayoutRestrictions": [
{
"Id": "8d9012ef-gh34-56i7-jk89-012345l67890",
"Rules": [
{
"Variable": "PATH_MEDIA_COUNT",
"Operator": "IS",
"Values": [
"50"
]
}
]
}
],
"Limits": [
{
"Type": "ACTION",
"Value": "100.0",
"LimitBy": "CUSTOMER",
"Period": "DAY",
"WeekendOverrideValue": "500"
}
],
"Locking": {
"Basis": "TRACKED",
"Period": "MONTH",
"MonthOffset": "1",
"DayOffset": "0"
},
"PayoutScheduling": {
"Basis": "LOCKED",
"Period": "END_OF_MONTH"
},
"CreditPolicy": "LAST_REFERRER",
"ValidReferrals": [
{
"Type": "CLICKS",
"Window": "30",
"WindowUnit": "DAY"
}
]
}
],
"PromotionalTerms": [
{
"TermsName": "Custom Terms",
"TermsType": "CUSTOM",
"TermsContent": "<p>These are custom terms</p>\r\n"
}
],
"ChangeNotificationPeriod": "20",
"ReturnPolicy": "ALWAYS_OK",
"MaxReturnPercentage": "100",
"ActionLimit": "1500",
"ActionLimitPeriod": "MONTH",
"SpendLimit": "10000.00",
"SpendLimitPeriod": "MONTH",
"MinEarningPerClick": "0.00",
"ContractStartSlottingFee": "50.00",
"CustomCreativePayer": "ADVERTISER"
},
"CampaignTerms": [
{
"Name": "Product Boost Campaign 1",
"Id": "1234",
"StartDate": "2025-03-28T00:00:00-07:00",
"EndDate": "2025-03-29T00:00:00-07:00",
"EventPayouts": [
{
"EventTypeId": "13416",
"DefaultPayout": "10.00",
"PayoutLevel": "ORDER",
"PayoutGroups": [
{
"Id": "390c0f5a-5d0b-4626-b079-ddbcccb6e3fb",
"Rank": "1",
"Rules": [
{
"Variable": "ITEM_SKU",
"Operator": "IS",
"Values": [
"sku1"
]
}
],
"PayoutRate": "1"
},
{
"Id": "d54965b8-8cc7-4dab-8672-375f945b3a4a",
"Rank": "2",
"Rules": [
{
"Variable": "ITEM_SKU_LIST",
"Operator": "IS",
"Values": [
"11356"
]
}
],
"Payout": "1.00"
}
]
}
]
}
],
"PdfUri": "/Advertisers/<AccountSID>/Campaigns/1000/Contracts/S-7777777/Download",
"Uri": "/Advertisers/<AccountSID>/Campaigns/1000/Contracts/S-7777777"
}
