/people

get

https://api.securevan.com/v4/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.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

firstName

string

middleName

string

lastName

string

streetAddress

string

city

string

stateOrProvince

string

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

zipOrPostalCode

string

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

phoneNumber

string

Must be a valid phone number

string

Matches records with emails starting with this value

commonName

string

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

officialName

string

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

contactMode

string

enum

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

Allowed:

$top

int32

$skip

int32

$expand

string

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

$orderby

string

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

Responses

Language

Credentials

Basic

base64

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

400400