Contacts
Get Contact List
Changed onget/api/v1/Contacts/list
Request
- Base URLhttps://api.peakaccount.com
- Authnone declared. Required headers: Time-Stamp, Time-Signature, User-Token, Client-Token
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
status0 | 1 | 2
Status of Documents to be Filtered
groupIdstring
The Unique Identifier of a contact group. Used with status 2 (CustomGroup) to list the contacts in that group
searchTextstring
Related keyword used for searching data entries
limitinteger
Maximum number of entries to retrieve
pageinteger
Page number for displaying data, where each page will show 10 entries
Headers
Time-Stampstring required
Timestamp (yyyyMMddHHmmss)
Time-Signaturestring required
HMAC-SHA1 encrypted Time-Stamp where Secret Key is connectId
User-Tokenstring required
This token will be generated by PEAK.
Client-Tokenstring required
Token used to identify between client and PEAK to call API.
Response
Success
Changes
- warning
for the
queryrequest parameterlimit, the max was set to100.00 - warning
for the
queryrequest parameterlimit, the min was set to1.00 - warning
for the
queryrequest parameterpage, the min was set to1.00 - info
added the optional property
///to the response with the status
- warning