FOfolk
Campaigns

List campaigns

Changed on

Retrieve a paginated list of the campaigns you can access, newest first: those of your groups, and those created from a selection of contacts.<br/><Warning>This endpoint is currently in open beta. The API surface may change as we iterate based on feedback.</Warning>

get/v1/campaigns

Request

  • Base URL
    https://api.folk.app
  • URL
    https://api.folk.app/v1/campaigns
  • Auth
    HTTP bearer

Query parameters

limitinteger

The number of items to return.

cursorstring

A cursor for pagination across multiple pages of results. Don’t include this parameter on the first call. Use the pagination.nextLink value returned in a previous response to request subsequent results.

groupIdstring

Only list the campaigns of this group. Campaigns created from a selection of contacts have no group.

Response

A page of campaigns.

deprecationsstring[]

Example response

{
  "data": {
    "items": [
      {
        "id": "cmp_9b2f1c1e-2b8a-4d1e-8f5a-3c2d1e0f9a8b",
        "name": "Q3 outreach",
        "status": "draft",
        "groupId": "grp_bc984b3f-0386-434d-82d7-a91eb6badd71",
        "entityType": "person",
        "steps": [
          {
            "position": 1,
            "sender": {
              "id": "snd_4c3b2a19-8f7e-4d6c-9b5a-1e2f3d4c5b6a",
              "email": "john.doe@example.com",
              "displayName": "John Doe"
            },
            "subject": "Quick question, {{firstName}}",
            "body": "<p>Hi {{firstName}},</p><p>{{signature}}</p>",
            "cc": [],
            "bcc": [],
            "delayDays": 0,
            "sameThread": false,
            "status": "draft",
            "messageCount": 0,
            "sentCount": 0,
            "notSentCount": 0
          },
          {
            "position": 2,
            "sender": {
              "id": "snd_4c3b2a19-8f7e-4d6c-9b5a-1e2f3d4c5b6a",
              "email": "john.doe@example.com",
              "displayName": "John Doe"
            },
            "subject": "",
            "body": "<p>Following up on my last email, {{firstName}}.</p><p>{{signature}}</p>",
            "cc": [],
            "bcc": [],
            "delayDays": 3,
            "sameThread": true,
            "status": "draft",
            "messageCount": 0,
            "sentCount": 0,
            "notSentCount": 0
          }
        ],
        "stopOnReply": true,
        "recipientCount": 12,
        "createdBy": "usr_bc984b3f-0386-434d-82d7-a91eb6badd71",
        "createdAt": "2025-07-17T09:00:00.000Z",
        "updatedAt": "2025-07-17T09:00:00.000Z",
        "scheduledAt": null,
        "startedAt": null,
        "finishedAt": null,
        "error": null
      }
    ],
    "pagination": {
      "nextLink": "https://api.folk.app/v1/campaigns?limit=20&cursor=eyJvZmZzZXQiOjIwfQ%3D%3D"
    }
  },
  "deprecations": [
    "This field is deprecated"
  ]
}

Changes