/people

Returns a paginated list of contacts who meet all of the specified criteria.

Unless noted otherwise, search criteria can be partial inputs; they will match any string that starts with the value provided (case-insensitive).

At least one string parameter must be specified.

get/people

Request

firstNamestring

middleNamestring

lastNamestring

streetAddressstring

citystring

stateOrProvincestring

Must be a valid state or province code (two or three characters)

zipOrPostalCodestring

Must be a valid ZIP5 zip code or postal code. For UK clients, this parameter accepts valid partial postcodes (e.g., postcode sector).

phoneNumberstring

Must be a valid phone number

emailstring

Matches records with emails starting with this value

commonNamestring

If Organizations-as-Contacts is enabled in your database, matches organizations whose Common Name begins with this value.

officialNamestring

If Organizations-as-Contacts is enabled in your database, matches organizations whose Official Name begins with this value.

contactMode'Person' | 'Organization'

If Organizations-as-Contacts is enabled in your database, filters to records of this type.

$topinteger

$skipinteger

$expandstring

Valid $expand sections are are Addresses, Districts, Emails, and Phones.

$orderbystring

Name asc and Name desc are the only valid $orderby arguments

200

nextPageLinkunknown

countinteger

{
  "items": [
    {
      "vanId": 987654
    }
  ],
  "count": 2
}