List All Partners
Returns a list of all partner accounts in your program, with extensive filtering options.
Request
- Base URLhttps://api.impact.com
- Authnone declared
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
Query parameters
Comma-separated list of Partner IDs to filter by.
Filter by a specific campaign (program) ID.
Filter by a specific partner group ID.
Filter by a specific country code. Possible values: US, UK, CANADA, AUSTRALIA, GERMANY, FRANCE, AFGHANISTAN, ALAND ISLANDS, 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, 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, ISLE OF MAN, ISRAEL, ITALY, JAMAICA, JAPAN, JERSEY, 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, SERBIA, YUGOSLAVIA, 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, UNITED STATES MINOR OUTLYING ISLANDS, URUGUAY, UZBEKISTAN, VANUATU, VENEZUELA, VIETNAM, BRITISHVIRGINISLANDS, USVIRGINISLANDS, WALLISFUTUNA, WESTERNSAHARA, YEMEN, ZAMBIA, ZIMBABWE.
Filter for partners updated on or after this date.
Filter for partners updated on or before this date.
Filter by the partner account's state.
Filter by the partner's current relationship with your program. Possible values:
- ACTIVE — The partner has an active relationship with you.
- INACTIVE — The partner doesn't have a contractual relationship with you.
Response
A paginated list of partner objects.
Changes
No recorded changes to this operation across all 1 revision of this API.