NUnureply
Leads

List all leads from a lead list

Retrieve all leads associated with a specific lead list ID with support for pagination, search, and status filtering. Returns comprehensive lead information including engagement metrics and custom variables.

get/v3/user-api/leads/{leadListId}

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

Path parameters

leadListIdstring required

Query parameters

pagenumber
Example:1

Page number for pagination

limitnumber
Example:40

Number of leads per page

searchstring
Example:john

Search by email, first name, or last name

status'bounced' | 'clicked' | 'opened' | 'replied' | 'stopped' | 'unsubscribed'
Example:bounced

Filter by lead status

pagenumber
Example:1

Page number for pagination

limitnumber
Example:40

Number of leads per page

searchstring
Example:john

Search by email, first name, or last name

statusstring
Example:bounced

Filter by lead status

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 leads successfully",
  "data": [
    {
      "address": "john.doe@example.com",
      "firstName": "John",
      "lastName": "Doe",
      "companyName": "Acme Corporation",
      "linkedInUrl": "https://linkedin.com/in/johndoe",
      "websiteUrl": "https://example.com",
      "personalization": "I noticed your recent article about cloud infrastructure...",
      "domain": "example.com",
      "notes": [],
      "otherVariables": [
        {
          "name": "company_size",
          "value": "50-200 employees"
        }
      ],
      "completedStepIds": [],
      "receivedEmails": [],
      "leadListId": "653a2b0bf5444e11e5cdd1ce",
      "owner": "62878b4e647d7bd25db029a3",
      "_id": "653a45e0b2a95af9259031d5",
      "nextSendingDate": "2023-10-26T10:56:32.468Z",
      "createdAt": "2023-10-26T10:56:32.624Z",
      "updatedAt": "2023-10-26T10:56:32.624Z",
      "id": "653a45e0b2a95af9259031d5"
    }
  ],
  "total": 150,
  "page": 1,
  "limit": 40,
  "totalPages": 4,
  "hasMore": true
}

Changes

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