NUnureply
Campaigns

List campaigns

Retrieve paginated list of campaigns with filtering and sorting.

Filters:

  • status: active, paused, completed, archived, all
  • nameContains: Search by campaign name
  • emailAccountId: Filter by email account
  • leadlistId: Filter by lead list
  • tag: Filter by tag
  • createdFrom/To: Date range filter
get/v3/user-api/mail-campaigns

Request

  • Base URL
    https://api.nureply.com (the document declares no server; this is the origin it was published from)
  • Auth
    none declared. Required headers: x-personal-api-key

Query parameters

pagenumber
Example:1

Page number (1-indexed)

limitnumber
Example:20

Items per page

status'all' | 'active' | 'paused' | 'completed' | 'archived'
Example:active

Filter by campaign status

nameContainsstring
Example:Q1 Outreach

Search by campaign name (case-insensitive)

emailAccountIdstring
Example:65a1b2c3d4e5f6789abcdef0

Filter by email account ID

leadlistIdstring
Example:65a1b2c3d4e5f6789abcdef1

Filter by lead list ID

tagstring
Example:q1-2025

Filter by tag

createdFromstring
Example:2025-01-01T00:00:00Z

Created after date (ISO 8601)

createdTostring
Example:2025-12-31T23:59:59Z

Created before date (ISO 8601)

sortBy'createdAt' | 'updatedAt' | 'name'
Example:createdAt

Sort field

sortOrder'asc' | 'desc'
Example:desc

Sort order

pagenumber
Example:1

Page number (1-indexed)

limitnumber
Example:20

Items per page

statusstring
Example:active

Filter by campaign status

nameContainsstring
Example:Q1 Outreach

Search by campaign name (case-insensitive)

emailAccountIdstring
Example:65a1b2c3d4e5f6789abcdef0

Filter by email account ID

leadlistIdstring
Example:65a1b2c3d4e5f6789abcdef1

Filter by lead list ID

tagstring
Example:q1-2025

Filter by tag

createdFromstring
Example:2025-01-01T00:00:00Z

Created after date (ISO 8601)

createdTostring
Example:2025-12-31T23:59:59Z

Created before date (ISO 8601)

sortBystring
Example:createdAt

Sort field

sortOrderstring
Example:desc

Sort order

Headers

x-personal-api-keystring required

API Key from Dashboard

Response

messagestring required
totalnumber required
pagenumber required
limitnumber required
totalPagesnumber required
hasMoreboolean required

Example response

{
  "message": "Retrieved campaigns successfully",
  "data": [
    {
      "_id": "653a2b0bf5444e11e5cdd1ce",
      "name": "Q1 2024 Outreach Campaign",
      "dailySendingLimit": 5,
      "dailySendingLimitRemaining": 5,
      "leadList": "653a2b0bf5444e11e5cdd1d1",
      "totalSequences": 2,
      "createdAt": "2023-10-26T11:11:25.365Z",
      "id": "653a2b0bf5444e11e5cdd1ce"
    }
  ],
  "total": 15,
  "page": 1,
  "limit": 12,
  "totalPages": 2,
  "hasMore": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.