Skip to main content
GET
/
api
/
campaigns
/
contact-lists
Get all contact lists with pagination and filters
curl --request GET \
  --url https://apiv1.delightloop.ai/api/campaigns/contact-lists \
  --header 'x-api-key: <x-api-key>'
{
  "success": true,
  "statusCode": 200,
  "message": "Contact lists retrieved successfully",
  "data": {
    "items": [
      "<unknown>"
    ],
    "pagination": {
      "page": 1,
      "limit": 12,
      "total": 25,
      "totalPages": 3
    }
  },
  "timestamp": "2023-11-07T05:31:56Z"
}

Headers

​
x-api-key
string
required

auth key

Query Parameters

​
page
number

Page number for pagination

Required range: x >= 1
Example:

1

​
limit
number

Number of items per page (max 100)

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

12

​
status
enum<string>

Filter by status

Available options:
active,
archived
​
search
string

Search term for filtering lists by name or description

Example:

"newsletter"

​
sortBy
enum<string>

Field to sort by

Available options:
name,
createdAt,
updatedAt
​
sortOrder
enum<string>

Sort order

Available options:
asc,
desc
​
myContactList
boolean

Filter to show only contact lists created by the current user

Example:

true

Response

Contact lists retrieved successfully

​
success
boolean
Example:

true

​
statusCode
number
Example:

200

​
message
string
Example:

"Contact lists retrieved successfully"

​
data
object
​
timestamp
string<date-time>