Get Contact List
Get list of all contact or with in a specified range.
api/Contact
Query String
Parameter | Required | Value |
---|---|---|
mode | Mandatory | 1 |
orderBy | Optional | |
start | Optional | User Input |
isAlphaSearch | Optional |
Request Header
Parameter | Required | Value |
---|---|---|
TokenKey | Mandatory | User Input |
Accept-Language | Optional | en-US |
Accept-Encoding | Optional | gzip |
Content-Type | Mandatory | application/json |
Page | Optional | For getting all records at a time do not add Page parameter in request header |
PerPage | Optional | Use PerPage parameter to change maximum number of records per page during population of paginated data; by default each page contains at most 10 records at a time. |
Successful Response:
Content | List of Contact |
Example
LoginId:Yourmail@domain.com
Password:YourPassword
Content-Type:application/json
Decrypt:false
IsExpirable:false
TokenKey → Your-Key
{
"CompanyName": "Your comapny name",
"Fax": "",
"Address1": "Your Addreess1",
"Address2": "",
"City": "Your city",
"StateName": "Your Statename",
"CountryName": "Your Country",
"ZipCode": "Your zipcode",
"Phone": "",
"WebURL": "",
"PhoneWork": "Your work phone number",
"PhoneExt": "",
"PhoneAfterHrs": "",
"Pager": "",
"PhoneMobile": "",
"WorkingDays": "",
"WorkingStartHours": "",
"WorkingEndHours": "",
"TimeZone": "Your time zone",
"Title": "",
"LastLoginDate": "your last login date",
"StateID": 1,
"CountryID": 1,
"PWRoleID": 1,
"SYSRoleID": 4,
"SuperAdminType": 0,
"IsReseller": false,
"PCModuleID": 0,
"isGuestUser": false,
"PINProjectID": -1,
"LicenseUserType": 0,
"PWPLicUserType": 1,
"UserLicenseType": 0,
"StrLastLoginDate": "your last login date fomatted",
"LastLogoutDate": "your last logout date",
"StrLastLogoutDate": "your last logout date formatted",
"PrimaryUserID": 0,
"EncryptedPrimaryUserID": "your primary user id",
"Password": "your encrypted password",
"IsProfileCompleted": true,
"IsWelcomed": false,
"PWPSuperAdminType": 0,
"IsEmailVerified": true,
"GuestProjectCount": 0,
"AuthReason": 0,
"PWPSubscriptionType": 0,
"IsLatestDocumentHidingAllowed": false,
"AccountPaymentMode": 2,
"PWUserID": 0,
"EncryptedPWUserID": "your PWuserid",
"PWAccountID": 0,
"EncryptedPWAccountID": "Your pwa account id",
"PWContactID": 0,
"EncryptedPrimaryPWContactID": "Your primary contact id",
"PrimaryPWContactID": 0,
"EncryptedPWContactID": "",
"FirstName": "Your firstname",
"MiddleName": "Your middle name",
"LastName": "Your last name",
"Email": "YourEmail@domain.com",
"UserName": "your user name",
"Admin": false,
"Status": 1,
"AccountExpiryDate": "Your account expiry date",
"ShareProjectCount": 0,
"AccountCreateDate": "Your account create date",
"BillingStartDate": "Your billing start date"
}
Enum
Mode : 1 – Contact Contact
OrderBy : 0 – FirstName
1 – FirstNameDesc First Name Ascending
First Name Descending
isAlphaSearch :0 - False
1- True
UserLicenseType : 0 – Contact
1 – FreeUser Free User
2 – HostingUser Employee
3 – CollaborativeUser Shared User
4 – LiteUser Contact Lite User
Updated less than a minute ago