Retrieve all users

GET

/users/list

Retrieves a paginated list of users with optional search functionality.

Query Parameters

Name	Type	Required	Description
`limit`	`number`	No	Number of records to return per page. Default: `50`
`page`	`number`	No	Page number to retrieve. Default: `1`
`search`	`string`	No	Search keyword to filter users by first name, last name, or email

Request

Authorization

API Key

Add parameter in header

cmr-x-api-key

Example:

cmr-x-api-key: ********************

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location 'https://customers.coldmailreseller.com/api/v1/integration/users/list' \
--header 'cmr-x-api-key: <api-key>'

Responses

🟢200Success

application/json

Bodyapplication/json

Example

{
    "status": 200,
    "message": "Users",
    "data": {
        "users": [
            {
                "firstName": "john",
                "lastName": "doe",
                "email": "john@company.com",
                "id": "GFGSDBFNH498ZNARTF3YJRRED2D"
            },
            {
                "firstName": "jean",
                "lastName": "doe",
                "email": "jean@company.com",
                "id": "FDFDAHGFGSDBFNH498ZNARTSRED2D"
            },
            {
                "firstName": "michael",
                "lastName": "jones",
                "email": "jones@company.com",
                "id": "GAD34YBFNH498ZNARTF3YJRRED2D"
            }
        ],
        "pagination": {
            "totalSearchedCount": 3,
            "currentPage": 1,
            "nextPage": 2,
            "totalPages": 1
        }
    }
}

Modified at 2026-06-23 16:21:02

Cold Mail Reseller API Documentation

Get User Details

Retrieve all users

Query Parameters#

Request

Request Code Samples

Responses

Query Parameters