Search for all partners using the field values provided.
| Parameter | Description | Additional information |
|---|---|---|
| firstName | Where the First Name field BEGINS WITH this value |
Define this parameter in the request URI. |
| lastName | Where the Last Name field BEGINS WITH this value |
Define this parameter in the request URI. |
| address | Where the Address field BEGINS WITH this value |
Define this parameter in the request URI. |
| city | Where the City field BEGINS WITH this value |
Define this parameter in the request URI. |
| state | Where the State/Province field BEGINS WITH this value |
Define this parameter in the request URI. |
| postalCode | Where the Postal Code field BEGINS WITH this value |
Define this parameter in the request URI. |
| country | Where the Country Code field BEGINS WITH this value |
Define this parameter in the request URI. |
| company | Where the Company field CONTAINS this value |
Define this parameter in the request URI. |
| title | Where the Title/Prefix field CONTAINS this value |
Define this parameter in the request URI. |
| phone | Where the partner has a Phone Number which CONTAINS this value |
Define this parameter in the request URI. |
If formed as '_@__.__', then: Where BEGINS WITH, else: Where CONTAINS this value |
Define this parameter in the request URI. |
|
| page | Optional page number. If not included, page 1 will be returned. |
Define this parameter in the request URI. |
| pageSize | Optional page size, limit of 100. If not included, the default page size will be 25. |
Define this parameter in the request URI. |
| Number | Notes |
|---|---|
| #1 | You must pass at least 1 value to search by. |
| Field Name | Notes |
|---|---|
| NextPageLink | Contains the full URL necessary to retrieve the next page of records. |
| PageCount | The number of pages contained in the result set, based on the PageSize passed in the API request. |
| PreviousPageLink | Contains the full URL necessary to retrieve the previous page of records. |
| TotalCount | The total number of records contained in the result set. |
{
"NextPageLink": "sample string 1",
"PreviousPageLink": "sample string 2",
"PageCount": 3,
"TotalCount": 4,
"Partners": [
{
"ID": "sample string 2",
"Prefix": "sample string 3",
"FirstName": "sample string 4",
"MiddleName": "sample string 5",
"LastName": "sample string 6",
"Suffix": "sample string 7",
"Salutation": "sample string 8",
"Spouse": "sample string 9",
"SpouseLastName": "sample string 10",
"Company": "sample string 11",
"Address1": "sample string 12",
"Address2": "sample string 13",
"City": "sample string 14",
"StateProv": "sample string 15",
"PostalCode": "sample string 16",
"CountryCode": "sample string 17",
"PartnerPhones": [
{
"Type": "sample string 1",
"Priority": 1,
"Number": "sample string 2"
},
{
"Type": "sample string 1",
"Priority": 1,
"Number": "sample string 2"
},
{
"Type": "sample string 1",
"Priority": 1,
"Number": "sample string 2"
}
],
"PartnerAskArrays": [
{
"AskID": 1,
"AskAmount": "sample string 2"
},
{
"AskID": 1,
"AskAmount": "sample string 2"
},
{
"AskID": 1,
"AskAmount": "sample string 2"
}
],
"Email": "sample string 18",
"Email2": "sample string 19",
"Email3": "sample string 20",
"Email4": "sample string 21",
"EmailStatus": "sample string 22",
"EmailStatus2": "sample string 23",
"EmailStatus3": "sample string 24",
"EmailStatus4": "sample string 25",
"EmailType": "sample string 26",
"EmailType2": "sample string 27",
"EmailType3": "sample string 28",
"EmailType4": "sample string 29",
"EmailPreference": "sample string 30",
"WebURL": "sample string 31",
"BirthDate": "2024-09-09T13:39:53.323525-06:00",
"WeddingDate": "2024-09-09T13:39:53.323525-06:00",
"MemberDate": "2024-09-09T13:39:53.323525-06:00",
"OriginSource": "sample string 32",
"RequiresQC": true,
"Deceased": true,
"NoResponseLetters": true,
"NoDirectMail": true,
"NoTaxStatements": true,
"NoPhoneSolicitation": true,
"NoEmailSolicitation": true,
"NoTextSolicitation": true,
"NoRentOrExchange": true,
"NoVisits": true,
"UndeliverableAddress": true,
"NoMerge": true,
"VIP": true,
"Prospect": true,
"UndeliverableEmail": true,
"NoResponseEmails": true,
"NoAddressStandardization": true,
"WebUsername": "sample string 34",
"WebPassword": "sample string 35",
"WebMustChangePassword": true,
"WebPasswordRecoveryToken": "c1662579-ed9e-499f-b91e-c39926347c36",
"WebPasswordTokenExpiration": "2024-09-09T13:39:53.323525-06:00",
"CustomFlags": [
{
"FlagName": "sample string 1",
"StartDate": "2024-09-09T13:39:53.323525-06:00",
"ExpireDate": "2024-09-09T13:39:53.323525-06:00"
},
{
"FlagName": "sample string 1",
"StartDate": "2024-09-09T13:39:53.323525-06:00",
"ExpireDate": "2024-09-09T13:39:53.323525-06:00"
},
{
"FlagName": "sample string 1",
"StartDate": "2024-09-09T13:39:53.323525-06:00",
"ExpireDate": "2024-09-09T13:39:53.323525-06:00"
}
],
"CustomDataFields": [
{
"FieldName": "sample string 1",
"FieldValue": "sample string 2",
"FieldType": "sample string 3"
},
{
"FieldName": "sample string 1",
"FieldValue": "sample string 2",
"FieldType": "sample string 3"
},
{
"FieldName": "sample string 1",
"FieldValue": "sample string 2",
"FieldType": "sample string 3"
}
]
},
{
"ID": "sample string 2",
"Prefix": "sample string 3",
"FirstName": "sample string 4",
"MiddleName": "sample string 5",
"LastName": "sample string 6",
"Suffix": "sample string 7",
"Salutation": "sample string 8",
"Spouse": "sample string 9",
"SpouseLastName": "sample string 10",
"Company": "sample string 11",
"Address1": "sample string 12",
"Address2": "sample string 13",
"City": "sample string 14",
"StateProv": "sample string 15",
"PostalCode": "sample string 16",
"CountryCode": "sample string 17",
"PartnerPhones": [
{
"Type": "sample string 1",
"Priority": 1,
"Number": "sample string 2"
},
{
"Type": "sample string 1",
"Priority": 1,
"Number": "sample string 2"
},
{
"Type": "sample string 1",
"Priority": 1,
"Number": "sample string 2"
}
],
"PartnerAskArrays": [
{
"AskID": 1,
"AskAmount": "sample string 2"
},
{
"AskID": 1,
"AskAmount": "sample string 2"
},
{
"AskID": 1,
"AskAmount": "sample string 2"
}
],
"Email": "sample string 18",
"Email2": "sample string 19",
"Email3": "sample string 20",
"Email4": "sample string 21",
"EmailStatus": "sample string 22",
"EmailStatus2": "sample string 23",
"EmailStatus3": "sample string 24",
"EmailStatus4": "sample string 25",
"EmailType": "sample string 26",
"EmailType2": "sample string 27",
"EmailType3": "sample string 28",
"EmailType4": "sample string 29",
"EmailPreference": "sample string 30",
"WebURL": "sample string 31",
"BirthDate": "2024-09-09T13:39:53.323525-06:00",
"WeddingDate": "2024-09-09T13:39:53.323525-06:00",
"MemberDate": "2024-09-09T13:39:53.323525-06:00",
"OriginSource": "sample string 32",
"RequiresQC": true,
"Deceased": true,
"NoResponseLetters": true,
"NoDirectMail": true,
"NoTaxStatements": true,
"NoPhoneSolicitation": true,
"NoEmailSolicitation": true,
"NoTextSolicitation": true,
"NoRentOrExchange": true,
"NoVisits": true,
"UndeliverableAddress": true,
"NoMerge": true,
"VIP": true,
"Prospect": true,
"UndeliverableEmail": true,
"NoResponseEmails": true,
"NoAddressStandardization": true,
"WebUsername": "sample string 34",
"WebPassword": "sample string 35",
"WebMustChangePassword": true,
"WebPasswordRecoveryToken": "c1662579-ed9e-499f-b91e-c39926347c36",
"WebPasswordTokenExpiration": "2024-09-09T13:39:53.323525-06:00",
"CustomFlags": [
{
"FlagName": "sample string 1",
"StartDate": "2024-09-09T13:39:53.323525-06:00",
"ExpireDate": "2024-09-09T13:39:53.323525-06:00"
},
{
"FlagName": "sample string 1",
"StartDate": "2024-09-09T13:39:53.323525-06:00",
"ExpireDate": "2024-09-09T13:39:53.323525-06:00"
},
{
"FlagName": "sample string 1",
"StartDate": "2024-09-09T13:39:53.323525-06:00",
"ExpireDate": "2024-09-09T13:39:53.323525-06:00"
}
],
"CustomDataFields": [
{
"FieldName": "sample string 1",
"FieldValue": "sample string 2",
"FieldType": "sample string 3"
},
{
"FieldName": "sample string 1",
"FieldValue": "sample string 2",
"FieldType": "sample string 3"
},
{
"FieldName": "sample string 1",
"FieldValue": "sample string 2",
"FieldType": "sample string 3"
}
]
},
{
"ID": "sample string 2",
"Prefix": "sample string 3",
"FirstName": "sample string 4",
"MiddleName": "sample string 5",
"LastName": "sample string 6",
"Suffix": "sample string 7",
"Salutation": "sample string 8",
"Spouse": "sample string 9",
"SpouseLastName": "sample string 10",
"Company": "sample string 11",
"Address1": "sample string 12",
"Address2": "sample string 13",
"City": "sample string 14",
"StateProv": "sample string 15",
"PostalCode": "sample string 16",
"CountryCode": "sample string 17",
"PartnerPhones": [
{
"Type": "sample string 1",
"Priority": 1,
"Number": "sample string 2"
},
{
"Type": "sample string 1",
"Priority": 1,
"Number": "sample string 2"
},
{
"Type": "sample string 1",
"Priority": 1,
"Number": "sample string 2"
}
],
"PartnerAskArrays": [
{
"AskID": 1,
"AskAmount": "sample string 2"
},
{
"AskID": 1,
"AskAmount": "sample string 2"
},
{
"AskID": 1,
"AskAmount": "sample string 2"
}
],
"Email": "sample string 18",
"Email2": "sample string 19",
"Email3": "sample string 20",
"Email4": "sample string 21",
"EmailStatus": "sample string 22",
"EmailStatus2": "sample string 23",
"EmailStatus3": "sample string 24",
"EmailStatus4": "sample string 25",
"EmailType": "sample string 26",
"EmailType2": "sample string 27",
"EmailType3": "sample string 28",
"EmailType4": "sample string 29",
"EmailPreference": "sample string 30",
"WebURL": "sample string 31",
"BirthDate": "2024-09-09T13:39:53.323525-06:00",
"WeddingDate": "2024-09-09T13:39:53.323525-06:00",
"MemberDate": "2024-09-09T13:39:53.323525-06:00",
"OriginSource": "sample string 32",
"RequiresQC": true,
"Deceased": true,
"NoResponseLetters": true,
"NoDirectMail": true,
"NoTaxStatements": true,
"NoPhoneSolicitation": true,
"NoEmailSolicitation": true,
"NoTextSolicitation": true,
"NoRentOrExchange": true,
"NoVisits": true,
"UndeliverableAddress": true,
"NoMerge": true,
"VIP": true,
"Prospect": true,
"UndeliverableEmail": true,
"NoResponseEmails": true,
"NoAddressStandardization": true,
"WebUsername": "sample string 34",
"WebPassword": "sample string 35",
"WebMustChangePassword": true,
"WebPasswordRecoveryToken": "c1662579-ed9e-499f-b91e-c39926347c36",
"WebPasswordTokenExpiration": "2024-09-09T13:39:53.323525-06:00",
"CustomFlags": [
{
"FlagName": "sample string 1",
"StartDate": "2024-09-09T13:39:53.323525-06:00",
"ExpireDate": "2024-09-09T13:39:53.323525-06:00"
},
{
"FlagName": "sample string 1",
"StartDate": "2024-09-09T13:39:53.323525-06:00",
"ExpireDate": "2024-09-09T13:39:53.323525-06:00"
},
{
"FlagName": "sample string 1",
"StartDate": "2024-09-09T13:39:53.323525-06:00",
"ExpireDate": "2024-09-09T13:39:53.323525-06:00"
}
],
"CustomDataFields": [
{
"FieldName": "sample string 1",
"FieldValue": "sample string 2",
"FieldType": "sample string 3"
},
{
"FieldName": "sample string 1",
"FieldValue": "sample string 2",
"FieldType": "sample string 3"
},
{
"FieldName": "sample string 1",
"FieldValue": "sample string 2",
"FieldType": "sample string 3"
}
]
}
]
}
<PartnerSearchModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDS.Web.WebApi.Models"> <NextPageLink>sample string 1</NextPageLink> <PageCount>3</PageCount> <PreviousPageLink>sample string 2</PreviousPageLink> <TotalCount>4</TotalCount> </PartnerSearchModel>