Skip to main content
GET
Retrieve contact list with optional search and pagination

Authorizations

api_key
string
header
required

Headers

Company-Name
string
required

The schema name for multi-tenancy (company-wise DB separation)

Query Parameters

page
integer

Page number for pagination

Example:

1

Search term to filter contacts by name, number, or other fields

Example:

"john"

Response

Successfully retrieved contact list

total_count
integer
required

Total number of contacts available

total_page
integer
required

Total number of pages for pagination

current_page_no
integer
required

The current page number being viewed

next_page_number
integer | null
required

The next page number if available, otherwise null

previous_page_number
integer | null
required

The previous page number if available, otherwise null

page_size
integer
required

The number of contacts per page

data
object[]
required

List of contact objects for the current page