contacts
Search Contacts
Use this endpoint to get a list of contacts matching the given search criteria. Contacts are returned if they include a given first name, last name, company name, and contact type. it will filter by range of dates, using the CreationDate of the contact. The size of the return is controlled with the pageSize query parameter which defaults to 25 and must be > 0 and <= 25. Set pageIndex > 0 to access contacts past the first page when more than pageSize contacts meet the search criteria. Sort criteria, startDate and endDate are required. The search returns includes like phone numbers, email addresses and location address.
post/contacts/search
Query parameters
pageSizeinteger
Controls how many items are returned per page in paginated responses.
- Default: 25 items per page if not specified
- Minimum: 1 item per page
- Use with pageStartIndex for navigating through large result sets
pageStartIndexinteger
The index of the page to return
Request body
Example request
{
"contactTypes": [
"Customer"
],
"searchTerm": "John Smith",
"startDate": "2023-01-01T00:00:00Z",
"endDate": "2023-06-30T23:59:59Z"
}Response
OK