Get Contact List

Get list of all contact or with in a specified range.

ContactEx/GetContactsForExternalUser

Query String

Parameter

Required

Value

mode

Mandatory

3

externalUser

Mandatory

1

startIndex

Optional

User Input

endIndex

Optional

User Input

Request Header

Parameter

Required

Value

TokenKey

Mandatory

User Input

ModuleKeyRequest

Mandatory

PWP

Accept-Language

Optional

en-US

Accept-Encoding

Optional

gzip

Content-Type

Mandatory

application/json

SortBy

Optional

"ContactFirstName", "ContactLastName", "ContactCompany"

SortOrder

Optional

0(Ascending) and 1(Descending)

Successful Response:

Content

List of Contact

Example

mode: UserInput
externalUser:1
startIndex:UserInput
endIndex:UserInput
TokenKey:Your Token Key
ModuleKeyRequest:PWP
Accept-Language:en-US
Accept-Encoding:gzip
Content-Type:application/json
SortBy : UserInput
SortOrder :UserInput
[
  {
    "PWContactID": 0,
    "EncryptedPWContactID": "PO%40asQLqouFgXI1o%4026S3w%3d%3d",
    "PublicPWAccountID": 0,
    "EncryptedPublicPWAccountID": "8Hq5jgK1axM%3d",
    "FirstName": "test",
    "MiddleName": "",
    "LastName": "",
    "Email": "[email protected]",
    "Phone": "",
    "PhoneWork": "",
    "ContactName": "test",
    "CompanyName": "Test Company",
    "IsPublicContact": false,
    "UserLicenseType": 0,
    "PWPLicUserType": 3,
    "Admin": false,
    "ShareProjectCount": 0,
    "GuestPWUserID": 0,
    "EncryptedGuestPWUserID": "CW7njOk%2fRo4%3d"
  },
  {
    "PWContactID": 0,
    "EncryptedPWContactID": "n58d6pCEzmcm3jWFJCEKUA%3d%3d",
    "PublicPWAccountID": 0,
    "EncryptedPublicPWAccountID": "8Hq5jgK1axM%3d",
    "FirstName": "test1",
    "MiddleName": "",
    "LastName": "",
    "Email": "[email protected]",
    "Phone": "",
    "PhoneWork": "",
    "ContactName": "test1",
    "CompanyName": "Test Company",
    "IsPublicContact": false,
    "UserLicenseType": 0,
    "PWPLicUserType": 3,
    "Admin": false,
    "ShareProjectCount": 0,
    "GuestPWUserID": 0,
    "EncryptedGuestPWUserID": "CW7njOk%2fRo4%3d" }]

1) In Query String: startIndex and endIndex is user input. It defined from which index to which index data required. If startIndex and endIndex value is zero then it returned all data.
2) In Header: SortBy and SortOrder is optional field. It only works above mention value only.