Get All Contacts

Fetches a list of all contacts for a specific integration (channel).

Endpoint

POST /api/contacts/v3/page

Base URL

URL

https://api.rampwin.com

---

Description

Retrieves all contacts associated with a given channel (integration ID) with pagination support.

Supports

• Pagination (page & page size)
• Fetch all contacts (no filters required)
• Optional page count
• User-only filtering toggle

---

Authentication

This API requires:

• JWT Bearer Token

---

Headers

Header	Type	Required	Description
Content-Type	string	Yes	application/json;charset=UTF-8
Accept	string	Yes	application/json, text/plain, /
Authorization	string	Yes	Bearer Token
Origin	string	No	https://app.rampwin.com
Referer	string	No	https://app.rampwin.com/
Accept-Language	string	No	Language preferences
User-Agent	string	No	Client user agent

---

Request Body

Field	Type	Required	Description
page	number	Yes	Page number (starts from 1)
pageSize	number	Yes	Number of records per page
integrationId	string	Yes	Channel / Integration ID
pageCountRequired	string	No	"yes" to include total page count
showOnlyUsers	boolean	No	If true, returns only user-type contacts
contactQueryType	array	No	Used for advanced querying (can be empty)
fitlers (typo)	array	No	Filters array (keep empty to fetch all contacts)

---

Example Request

cURL

curl --location 'https://api.rampwin.com/api/contacts/v3/page' \
--header 'accept: application/json, text/plain, */*' \
--header 'authorization: Bearer YOUR_TOKEN' \
--header 'content-type: application/json;charset=UTF-8' \
--data-raw '{
  "page": 1,
  "pageSize": 10,
  "integrationId": "Your_Channel_ID",
  "pageCountRequired": "yes",
  "showOnlyUsers": false,
  "contactQueryType": [],
  "fitlers": []
}'

---

Response

Success (200)

JSON

{
  "success": true,
  "data": {
    "contacts": [
      {
        "_id": "contact_id",
        "full_name": "John Doe",
        "phone_number": "91XXXXXXXXXX",
        "is_user": true,
        "createdAt": "2026-05-01T10:00:00Z",
        "updatedAt": "2026-05-04T10:00:00Z"
      }
    ],
    "page": 1,
    "pageSize": 10,
    "totalPages": 5
  }
}

---

Error (400)

JSON

{
  "success": false,
  "errors": {
    "message": "Invalid request parameters"
  }
}

---

Business Logic Notes

• integrationId is mandatory to fetch contacts for a specific channel
• Keep fitlers = [] to retrieve all contacts
• If showOnlyUsers = true
  → Only registered users will be returned
• If pageCountRequired = "yes"
  → Response includes total page count

---

Common Errors

Error	Description
Invalid token	Unauthorized access
Validation error	Missing or incorrect fields
Integration not found	Invalid channel ID