website logo
Version 2.0 API
Previous Version 1.0
Navigate through spaces
⌘K
Introduction: API Reference
Authentication
Webhooks Integration
What Is Webhook Event
Setup Live Webhook
Test & Validate Webhook
Sample Payload
Edit Webhook
Delete Webhook
Test API via Postman
Setup Postman
CallerDesk <> Postman
Team Members
Add Member
Update Member
Delete Member
Get Members List
Call Group
Call Group List
Update Call Group
Create Call Group
Delete Call Group
Get Group details by id
Get Group Time Schedule
Call Report API
Call Report API
Live Call API
Call Routing API
Click-to-Call API's
Click2Call API ( Normal )
Click2Call API (with CallGroup)
Reverse C2C API ( B Party=Member Number)
Reverse C2C API ( B Party=Deskphone with CallGroup)
Contact API's
Contact notes API
Get Contact List
Add contact
Edit contact
Delete contact
Bulk Voice Brodcast
Bulk Voice Broadcast
Bulk Voice Broadcast Report
Voice OTP API's
Number Blacklist API's
Block Number
Unblock Number
Account Sender id's
Add Sender id
Get Sender id
Delete Sender id's
Account Level API's
Activity Trail History
Profile & Balance
IVR Number List
Member Analysis
Notification Settings
Notification List
Update Notification
Docs powered by
Archbee
Contact API's

Get Contact List

1min



This API is used for fetching the whole contact list.
POST
Params
Header Parameters
current_page
optional
Integer
Denotes the page range
per_page
optional
Integer
Denotes the number of entries per page(current limit set at)
start_date
optional
Integer
The start date from which the contacts are fetched
end_date
optional
Integer
The end date from up till which the contacts are needed
Form Parameters
contact_id
optional
Integer
The unique ID of contact
contact_num
optional
Integer
The number of the contact
contact_name
optional
String
Name of contact
contact_email
optional
String
The mail of the contact
contact_address
optional
String
The address provided by the contact
member_name
optional
String
Name of the member to which the contact is assigned
contact_status
optional
String
what is the status of the lead, for example: hot,warm,cold,etc.
contact_comment
optional
String
Any comment about the contact
contact_savedate
optional
Integer
The date on which the contact was saved
contact_followupdate
optional
String
Denotes if the follow up is required or not
deskphone
optional
Integer
The deskphone for which the contact is aved




Updated 24 Apr 2023
Did this page help you?
PREVIOUS
Contact notes API
NEXT
Add contact
Docs powered by
Archbee
Get contact list