GET api/clientcontacts?description={description}&descriptionContains={descriptionContains}&hasPhoneNumber={hasPhoneNumber}&hasEmailAddress={hasEmailAddress}&inactive={inactive}

Get all Client Contact optionally filtered by any of the arguments specified in the query string.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
description

Optional case-insensitive filter on Client Contacts with a description that matches the provided value.

string

None.

descriptionContains

Optional case-insensitive filter on Client Contacts with a description containing the provided value.

string

None.

hasPhoneNumber

Filter indicating whether to retrieve active or inactive records.

boolean

None.

hasEmailAddress

Filter indicating whether to retrieve records with an email address.

boolean

None.

inactive

Filter indicating whether to retrieve active or inactive records.

boolean

Default value is False

Body Parameters

None.

Response Information

Resource Description

ClientContactDto
NameDescriptionTypeAdditional information
Description

The name of the Client Contact record.

string

None.

EmailAddresses

Email Addresses of the Client Contact record.

string

String length: inclusive between 0 and 2000

PhoneNumber

Phone Number of the Client Contact record.

string

None.

Inactive

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "Description": "sample string 1",
  "EmailAddresses": "sample string 2",
  "PhoneNumber": "sample string 3",
  "Inactive": true
}