Skip to main content
GET
/
v2
/
contact
Retrieve contact list with optional search and pagination
curl --request GET \
  --url https://app.closerx.ai/api/v2/contact/ \
  --header 'Company-Name: <company-name>' \
  --header 'api_key: <api-key>'
{
  "total_count": 123,
  "total_page": 123,
  "current_page_no": 123,
  "next_page_number": 123,
  "previous_page_number": 123,
  "page_size": 123,
  "data": [
    {
      "id": 123,
      "contact_number": "<string>",
      "isactive": true,
      "tags": [
        {
          "id": 123,
          "tag_name": "<string>"
        }
      ],
      "email": "<string>",
      "first_name": "<string>",
      "last_name": "<string>",
      "company_name": "<string>",
      "industry": "<string>",
      "custom1": "<string>",
      "custom2": "<string>",
      "custom3": "<string>",
      "custom4": "<string>",
      "address": "<string>",
      "contact_id": "<string>"
    }
  ]
}

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
string

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