For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.

Guides SDK Recipes API Reference Integrations Compare Changelog

API Reference

API Reference Email

List campaigns

GET

https://api.recursiv.io/api/v1/email/campaigns

GET

/api/v1/email/campaigns

$ curl https://api.recursiv.io/api/v1/email/campaigns \
>      -H "Authorization: Bearer <token>"

1 {
2   "data": [
3     {
4       "id": "string",
5       "name": "string",
6       "subject": "string",
7       "from_email": "string",
8       "from_name": "string",
9       "segment": "string",
10       "status": "string",
11       "total_recipients": 1,
12       "sent_count": 1,
13       "delivered_count": 1,
14       "bounce_count": 1,
15       "open_count": 1,
16       "click_count": 1,
17       "warmup_enabled": true,
18       "scheduled_at": "2024-01-15T09:30:00Z",
19       "created_at": "2024-01-15T09:30:00Z"
20     }
21   ]
22 }

Response

List of campaigns

datalist of objectsOptional

Errors

401

Unauthorized Error

404

Not Found Error

Was this page helpful?

Create a campaign