Returns a list of all your partners. The partners are sorted by DateCreated
, with the oldest one appearing first.
Parameters
CampaignId
optional
CampaignId
optionalFilters the list to only list partners that are joined to the specified campaign (or program).
RelationshipState
optional
RelationshipState
optionalFilters the list based on the specified value, ACTIVE
or INACTIVE
, only listing partners matching the value.
GroupId
optional
GroupId
optionalFilters the list based on the specified partner group ID, only listing partners that are a part of that group.
Country
optional
Country
optionalFilters the list based on the specified country enum value, only listing partners from that country.
View possible country values
Possible enum values |
---|
US |
UK |
CANADA |
AUSTRALIA |
GERMANY |
FRANCE |
AFGHANISTAN |
ALBANIA |
ALGERIA |
AMERICANSAMOA |
ANDORRA |
ANGOLA |
ANGUILLA |
ANTARCTICA |
ANTIGUABARBUDA |
ARGENTINA |
ARMENIA |
ARUBA |
AUSTRIA |
AZERBAIJAN |
BAHAMAS |
BAHRAIN |
BANGLADESH |
BARBADOS |
BELARUS |
BELGIUM |
BELIZE |
BENIN |
BERMUDA |
BHUTAN |
BOLIVIA |
BOSNIAHERZEGOVINA |
BOTSWANA |
BRAZIL |
BRITISHINDIANOCEANTERRITORY |
BRUNEIDARUSSALAM |
BULGARIA |
BURKINAFASO |
BURUNDI |
CAMBODIA |
CAMEROON |
CAPVERDE |
CAYMANISLANDS |
CENTRALAFRICANREPUBLIC |
CHAD |
CHILE |
CHINA |
CHRISTMASISLAND |
COCOSISLANDS |
COLOMBIA |
COMOROS |
CONGO |
DEMOCRATICREPUBLICCONGO |
COOKISLANDS |
COSTARICA |
IVORYCOAST |
CROATIA |
CUBA |
CYPRUS |
CZECHREPUBLIC |
DENMARK |
DIJIBOUTI |
DOMINICA |
DOMINICANREPUBLIC |
ECUADOR |
EGYPT |
ELSALVADOR |
EQUATORIALGUINEA |
ELSALVADOR |
ERITREA |
ESTONIA |
ETHIOPIA |
FALKLANDISLANDS |
FAROEISLANDS |
FIJI |
FINLAND |
FRENCHGUIANA |
FRENCHPOLYNESIA |
FRENCHSOUTHERNTERRITORIES |
GABON |
GAMBIA |
GEORGIA |
GHANA |
GIBRALTAR |
GREECE |
GREENLAND |
GRENADA |
GUADELOUPE |
GUAM |
GUATEMALA |
GUERNSEY |
GUINEA |
GUINEABISSAU |
GUYANA |
HAITI |
VATICAN |
HONDURAS |
HONGKONG |
HUNGARY |
ICELAND |
INDIA |
INDONESIA |
IRAN |
IRAQ |
IRELAND |
ISRAEL |
ITALY |
JAMAICA |
JAPAN |
JORDAN |
KAZAKHSTAN |
KENYA |
KIRIBATI |
SOUTHKOREA |
KUWAIT |
KYRGYZSTAN |
LAOS |
LATVIA |
LEBANON |
LESOTHO |
LIBERIA |
LIBYA |
LICHTENSTEIN |
LITHUANIA |
LUXEMBOURG |
MACAO |
MACEDONIA |
MADAGASCAR |
MALAWI |
MALAYSIA |
MALDIVES |
MALI |
MALTA |
MARSHALLISLANDS |
MARTINIQUE |
MAURITANIA |
MAURITIUS |
MAYOTTE |
MEXICO |
MICRONESIA |
MOLDOVA |
MONACO |
MONGOLIA |
MONTENEGRO |
MONTSERRAT |
MOROCCO |
MOZAMBIQUE |
MYANMAR |
NAMIBIA |
NAURU |
NEPAL |
NETHERLANDS |
NETHERLANDSANTILLES |
NEWCALEDONIA |
NEWZEALAND |
NICARAGUA |
NIGER |
NIGERIA |
NIUE |
NORFOLKISLAND |
NORTHKOREA |
NORTHERNMARIANAISLANDS |
NORWAY |
OMAN |
PAKISTAN |
PALAU |
PALESTINIANTERRITORY |
PANAMA |
PAPUANEWGUINEA |
PARAGUAY |
PERU |
PHILIPPINES |
PITCAIRN |
POLAND |
PORTUGAL |
PUERTORICO |
QATAR |
REUNION |
ROMANIA |
RUSSIA |
RWANDA |
SAINTHELENA |
SAINTKITTSNEVIS |
SAINTLUCIA |
SAINTPIERREMIQUELON |
SAINTVINCENTGRENADINES |
SAMOA |
SANMARINO |
SAOTOME |
SAUDIARABIA |
SENEGAL |
YOGOSLAVIA |
SEYCHELLES |
SIERRALEONE |
SINGAPORE |
SLOVAKIA |
SLOVENIA |
SOLOMONISLANDS |
SOMALIA |
SOUTHAFRICA |
SPAIN |
SRILANKA |
SUDAN |
SURINAME |
SVALBARDJANMAYEN |
SWAZILAND |
SWEDEN |
SWITZERLAND |
SYRIA |
TAIWAN |
TAJIKISTAN |
TANZANIA |
THAILAND |
TIMOR |
TOGO |
TOKELAU |
TONGA |
TRINIDADTOBAGO |
TUNISIA |
TURKEY |
TURKMENISTAN |
TURKSCAICOSISLANDS |
TUVALU |
UGANDA |
UKRAINE |
UAE |
URUGUAY |
UZBEKISTAN |
VANUATU |
VENEZUELA |
VIETNAM |
BRITISHVIRGINISLANDS |
USVIRGINISLANDS |
WALLISFUTUNA |
WESTERNSAHARA |
YEMEN |
ZAMBIA |
ZIMBABWE |
Returns
Returns an array of partners up to a limit dictated by @pagesize
. Each entry in the array is a separate partner. If no partners meet the criteria, the resulting array will be empty. This request should never return an error.
Example request
curl 'https://api.impact.com/Advertisers/<AccountSID>/MediaPartners' \
-X GET \
-u '<AccountSID>:<AuthToken>' \
-H 'Accept: application/json' \
-H 'RelationshipStatus=ACTIVE' \
-H 'Country=US'
Example response
{
"@page": "1",
...
"Partners": [
{
"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"
},
...
]
}