Global API
...
Requests
Contact

Read

5min

To read Conacts, please use the below parameters.

Field Name

Data Type

Description

customParameters

Map<String, ParamValue>

It is used to add filters to your search results

pageIndex

Integer

request any page from the search results reponse

searchId

String

request any page with the Search Id from the search results reponse

customPageSize

String

no. of records to return per search request.

Custom Parameters in the requestJSON are in the form of Param Name and Value Map which are used for filtering different search results. There is currently only one supported custom parameter.

Supported Custom Parameters

Field Name

Data Type

Description

where

keyValueMap

Pass the supported where filters in the Key-Value pair

Param Value can be passed in the following two ways.

ParamValue

Field Name

Data Type

Description

value

String

single param value

keyValueMap

Map<String, String>

adding multiple key value params (where filters)

Supported “where” Filters

Field Name

Data Type

Description

dateCreated

Long

This will filter on an exact match (equal). Use the “additionalFilter” option for a range of dates.

internalId

String

Internal ID of the Contact. Multiple values can be passed in a comma-separated string.

lastModifiedDate

Long

This will filter on an exact match (equal). Use the “additionalFilter” option for a range of dates.

stage

String

stage can be ‘_customer’, ‘_prospect’ or ‘_lead’. Multiple values can be passed in a comma-separated string Ex: _customer,_prospect

subsidiary

String

Internal ID of Subsidiary (Primary). Do Not Use this in additonalFilter. Multiple IDs can be passed in a comma-separated string Ex: 1,2

additonalFilter

String

construct the additional filter with a combination of above fields using ‘+and+’ separator and pass it as a single string. Make sure to wrap the whole string using EncodingUtil.urlEncode

Example

Request
Response




Updated 26 Jul 2023
Doc contributor
Doc contributor
Doc contributor
Doc contributor
Did this page help you?