Skip to main content
GET
/
api
/
campaigns
/
contacts
Get all contacts with optional search and pagination
curl --request GET \
  --url https://apiv1.delightloop.ai/api/campaigns/contacts \
  --header 'x-api-key: <x-api-key>'
{
  "items": [
    {
      "contactId": "contact_123",
      "organizationId": "org_123",
      "mailId": "[email protected]",
      "isDeleted": false,
      "createdAt": "2023-01-01T00:00:00.000Z",
      "updatedAt": "2023-01-01T00:00:00.000Z",
      "listIds": [
        "list_123",
        "list_456"
      ],
      "phoneNumber": "+1-555-0101",
      "firstName": "John",
      "lastName": "Doe",
      "fullName": "John Doe",
      "jobTitle": "Software Engineer",
      "companyName": "TechCorp Inc",
      "companyId": "comp_123",
      "linkedinUrl": "https://linkedin.com/in/johndoe",
      "profileImage": "https://media.licdn.com/dms/image/profile.jpg",
      "notes": "Important client, follow up next week about Q1 planning",
      "tags": [
        {
          "name": "developer",
          "color": "#3357FF"
        },
        {
          "name": "senior",
          "color": "#FF5733"
        }
      ],
      "address": {
        "line1": "123 Main St",
        "city": "San Francisco",
        "state": "CA",
        "country": "US",
        "zip": "94102"
      },
      "emails": [
        {
          "email": "[email protected]",
          "isPrimary": false,
          "isVerified": false,
          "source": {
            "type": "manual",
            "addedAt": "2023-01-01T00:00:00.000Z"
          },
          "addedAt": "2023-01-01T00:00:00.000Z",
          "updatedAt": "2023-01-01T00:00:00.000Z"
        }
      ],
      "addresses": [
        {
          "line1": "456 Old St",
          "city": "Los Angeles",
          "state": "CA",
          "country": "US",
          "zip": "90210",
          "type": "other",
          "isPrimary": false,
          "isVerified": false,
          "source": {
            "type": "manual",
            "addedAt": "2023-01-01T00:00:00.000Z"
          },
          "addedAt": "2023-01-01T00:00:00.000Z",
          "updatedAt": "2023-01-01T00:00:00.000Z"
        }
      ],
      "sources": [
        {
          "type": "manual",
          "provider": "manual",
          "addedAt": "2023-01-01T00:00:00.000Z"
        }
      ],
      "usage": {
        "campaignIds": [
          "campaign_123"
        ]
      },
      "campaigns": [
        {
          "campaignId": "camp_123",
          "campaignName": "Holiday Gift Campaign",
          "status": "active"
        }
      ]
    }
  ],
  "total": 50,
  "page": 1,
  "limit": 12,
  "totalPages": 5
}

Headers

​
x-api-key
string
required

auth key

Query Parameters

​
page
number

Page number (starts from 1)

Required range: x >= 1
Example:

1

​
limit
number

Number of results per page

Required range: 1 <= x <= 100
Example:

12

​
search
string

Optional search term to filter contacts

Example:

"john"

Response

All contacts retrieved successfully with pagination

​
items
object[]

Array of contacts with their list associations

​
total
number

Total number of contacts found

Example:

50

​
page
number

Current page number

Example:

1

​
limit
number

Number of items per page

Example:

12

​
totalPages
number

Total number of pages

Example:

5