HostedSuite

ListContactsRequest

Retrieve list of contact information

The following routes are available for this service:
POST	/api/contacts

**ListContactsRequest** Parameters:
Name	Parameter	Data Type	Required	Description
ClientId	body	string	No	Filter by client ID
CenterId	body	string	No	Filter by center ID
ContactId	body	string	No	ID of the contact you want to filter by. When using this only a single result will be returned.
FirstName	body	string	No	Filter by first name
LastName	body	string	No	Filter by last name
PhoneNumber	body	string	No	Filter by partial phone number match
ThirdPartyAccountId	body	string	No	Filter by third party account ID
EmailAddress	body	string	No	Filter by email address

**RequestBase<TResponse>** Parameters:
Name	Parameter	Data Type	Required	Description
CustomerName	form	string	Yes	The HostedSuite Customer Name
UserName	form	string	Yes	The HostedSuite User Name. Data visibility and security is based on this user's permissions.
Password	form	string	Yes	The HostedSuite User's Password

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/contacts HTTP/1.1 
Host: cpo.hostedsuite.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	ClientId: String,
	CenterId: String,
	ContactId: String,
	FirstName: String,
	LastName: String,
	PhoneNumber: String,
	ThirdPartyAccountId: String,
	EmailAddress: String,
	CustomerName: String,
	UserName: String,
	Password: String
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

[
	{
		Id: String,
		DateLastModified: String,
		ClientName: String,
		ClientId: String,
		CenterId: String,
		CenterName: String,
		FirstName: String,
		LastName: String,
		Alert: String,
		Name: String,
		Status: String,
		Location: String,
		LongDistanceCode: String,
		CallInstructions: String,
		Information: String,
		MoreInformation: String,
		Title: String,
		UserName: String,
		UserGroupId: String,
		LoginMustChangePasswordAtNextLogin: False,
		GreetingOverride: String,
		Keywords: 
		[
			String
		],
		Address: 
		{
			Street1: String,
			Street2: String,
			City: String,
			State: String,
			PostalCode: String,
			Country: String
		},
		PhoneNumbers: 
		[
			{
				Id: String,
				Name: String,
				Number: String,
				DialingRuleId: String,
				Mobile: False,
				TransferTypes: Both
			}
		],
		EmailAddresses: 
		[
			{
				Id: String,
				Address: String,
				Name: String,
				IncludeInNotifications: False,
				Type: To
			}
		],
		CustomFields: 
		[
			{
				Name: String,
				Value: String
			}
		],
		Links: 
		[
			{
				Id: String,
				Name: String,
				Url: String
			}
		],
		Categories: 
		[
			{
				Id: String,
				Name: String
			}
		],
		ThirdPartyAccountId: String,
		SortPositionInConsole: 0,
		HideInConsole: False
	}
]