-
Notifications
You must be signed in to change notification settings - Fork 0
Contacts
ipro-dave edited this page Dec 1, 2021
·
11 revisions
Request Url: /apis/contacts?size=15&index=1&term=&phone=01380819474
-
size
is the page size, default value is 15. -
index
starts from 1, default value is 1. -
term
will be used to match FirstName, LastName, Email, City, Postcode in server. -
phone
this will search the following fields Phone, Mobile, Alt Phone
The phone number can start with the * wildcard. For example, *1632 689 000 would match contact with a phone number in any of the following formats:
0044 1632 689 000
+44 1632 689 000
01632 689 000
1632 689 000
+0044 1632 689 000
If there are duplicate records they will be displayed in contactID order so the latest ID will be displayed last.
i.e. Id1, Id2, Id3, Id4 etc....
Response:
{
"TotalHits": 9360,
"Items": [
{
"Id": 68,
"CompanyId": 1,
"FullName": "Ipro Software",
"Country": "United Kingdom",
"Title": "",
"FirstName": "Ipro",
"LastName": "Software",
"Language": null,
"Email": "info@ipro-software.com",
"EmailAlt": "",
"EmailAlt1": "",
"Telephone": "",
"TelephoneAlt": "",
"Mobile": "",
"Postcode": ".123",
"Address": "17 Bolts Croft",
"StreetName": "",
"TownCity": ".test",
"CountyArea": "Wiltshire",
"CountryCode": "GB",
"CompanyName": "iPro Holidays",
"Comments": "",
"TypeId": 5,
"TypeName": "Travel Agent",
"ContactByPost": true,
"ContactByEmail": true,
"ContactByPhone": true,
"ContactBySms": true,
"SubscribedToMailingList": false,
"Commision": null,
"Balance": null,
"Retainer": null
},
{
"Id": 1902,
"CompanyId": 1555,
"FullName": "John Lesley Clark",
"Country": "United Kingdom",
"Title": "Mr",
"FirstName": "John Lesley",
"LastName": "Clark",
"Language": null,
"Email": "andy.jones@ipro-software.com",
"EmailAlt": "",
"EmailAlt1": null,
"Telephone": "01624 671088",
"TelephoneAlt": null,
"Mobile": "0034 602650877",
"Postcode": "IM3 2AW",
"Address": "6 Links View",
"StreetName": "Onchan,",
"TownCity": "Isle of Man",
"CountyArea": "",
"CountryCode": "GB",
"CompanyName": null,
"Comments": "",
"TypeId": 1,
"TypeName": "Renter",
"ContactByPost": true,
"ContactByEmail": true,
"ContactByPhone": true,
"ContactBySms": true,
"SubscribedToMailingList": false,
"Commision": null,
"Balance": null,
"Retainer": null
}
]
}
- Get Started Authentication
- Get Started Best Practise
- Settings
- Contacts
- Properties
- Properties
- Property Detail
- Property Images
- Property Extras
- Property Reference Lookup
- Property Rates
- Push Property Rates
- Property Custom Rates
- Property Availabilities
- Property Day Availabilities
- Property Rooms
- Property Distances
- Property All
- Property Search
- Property Search Lite
- Property Search Lite v2
- Property Enquiries
- Property Welcome Pack
- Push Property
- Properties Last Updated
- Property Day Availability Check
- Property Reviews
- Property Blockouts
- Property Detail Events
- Property Search Events
- Property Management
- Enquries
- Bookings
- Reviews
- Payments
- Offers & Deals
- Reports
- Communications