API Reference

Retrieve a partner

Retrieves the details of an existing partner. You only need to supply the unique identifier for the partner that was returned when creating or listing all partners.

Parameters

No parameters.

Returns

Returns a partner object if a valid identifier was provided.

Example request

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

Example response

{
  "Id": "10000",
  "Name": "Wile E. Coyote Partner",
  "Description": "Wile E. Coyote is the top influencer for Acme products! ",
  "Website": "example.com",
  "State": "ACTIVE",
  "Address": {
    "Country": "US",
    "Address1": "1640 Riverside Dr.",
    "Address2": "",
    "City": "Hill Valley",
    "State": "CA",
    "PostalCode": "90210"
  },
  "Phone": {
    "Country": "US",
    "Number": "18055550100"
  },
  "Currency": "USD",
  "Timezone": "America/Los_Angeles",
  "IndirectTax": {
    "Country": "",
    "Number": ""
  },
  "PartnerType": "MARKETPLACE",
  "PromotionalMethods": [
    {
      "Type": "COUPON",
      "IsPrimary": false
    },
    {
      "Type": "OFFLINE",
      "IsPrimary": false
    },
    {
      "Type": "SEARCH",
      "IsPrimary": false
    },
    {
      "Type": "SHOPPING",
      "IsPrimary": true
    }
  ],
  "PromotionalCountries": [
    "SOUTHAFRICA",
    "GERMANY",
    "JAPAN",
    "US",
    "SPAIN"
  ],
  "Properties": [
    {
      "Id": "271",
      "Name": "example.com",
      "Type": "WEBSITE",
      "Platform": "",
      "Url": "https://www.example.com",
      "Doe": "2010-05-24T13:58:57-04:00",
      "Dlu": "2020-03-05T11:57:20-05:00"
    },
    {
      "Id": "2552842",
      "Name": "Wile E. Coyote Facebook",
      "Type": "SOCIAL",
      "Platform": "FACEBOOK",
      "Url": "https://www.facebook.com/example",
      "Doe": "2021-04-01T04:07:48-04:00",
      "Dlu": "2021-04-01T04:07:48-04:00"
    }
  ],
  "PromotionalCategories": [
    "Auctions",
    "Handmade Goods",
    "Creative Digital Assets",
    "Flowers",
    "Gifts & Stationery",
    "Gourmet",
    "Wine & Spirits",
    "Food & Drink"
  ],
  "Programs": [
    {
      "Id": "1000",
      "Name": "Acme Brands",
      "ContractId": "12345",
      "ContractName": "Acme Public Terms ",
      "JoinDate": "2019-06-19T08:41:09-04:00",
      "Groups": [
        {
          "GroupId": "98765",
          "GroupName": "Influencers"
        }
      ]
    }
  ],
  "Contacts": [
    {
      "FirstName": "Wile",
      "LastName": "Coyote",
      "Labels": [],
      "Email": "[email protected]",
      "Phones": [
        {
          "Type": "CELL",
          "Country": "US",
          "Number": "18055550100"
        }
      ],
      "IsPrimary": true
    },
  ],
  "LinkedAccounts": [
    {
      "Id": "10001",
      "Reason": "Road Runner Partners",
      "Date": "2021-04-01T04:30:17-04:00"
    },
  ],
  "PartnerValues": {
    "Value1": "OFFLINE",
    "Value2": "",
    "Value3": ""
  },
  "AccountManager": "",
  "DateCreated": "2009-10-14T10:43:37-04:00",
  "DateLastUpdated": "2021-04-01T08:32:13-04:00",
  "CreatedBy": "unknown_user",
  "LastUpdatedBy": "Wile E. Coyote",
  "Uri": "/Advertisers/<AccountSID>/MediaPartners/10000.json"
}