v3

OpenAPI 3.1.1mit2026-07-3165481.5 MB
Campaigns
v1

Retrieve Campaigns

Retrieve the list of all campaigns available in the account. Use pagination to control the number of campaigns returned, and include related campaign data, campaign settings, list, or custom feed information when needed.

:::info Requires the campaigns:read OAuth2 scope. :::

get/v1/campaigns

Query parameters

account_idstring required

The Leadfeeder Account ID. The Account ID can be retrieved using the List Accounts endpoint.

page[num]integer

Page of results to fetch.

page[size]integer

The number of items per page. Maximum is 100.

includestring

Comma-separated list of related resources to inline inside each campaign's relationships block. Unknown values are silently ignored.

Supported values:

  • campaign_summary — aggregated lifetime campaign performance metrics (impressions, clicks, costs, reach, …).

  • campaign_settings — campaign-level configuration toggles such as brand safety domain exclusion and auto-include behaviour.

  • campaign_locations — geographical targets attached to the campaign.

  • list — the audience list (target companies) backing the campaign.

  • custom_feed — the custom website-visit feed used to retarget visitors.

By default (no include), each relationship in the response carries only an id / type reference (or null when not configured).

Response

Success

Example response

{
  "data": [
    {
      "type": "campaign",
      "id": "1234",
      "attributes": {
        "name": "Q2 EMEA enterprise push",
        "status": "draft",
        "start_date": "2026-05-01T00:00:00Z",
        "end_date": "2026-08-01T00:00:00Z",
        "location_type": "global",
        "budget_type": "total",
        "budget": 1000,
        "total_budget": 1000,
        "budget_left": 1000,
        "currency": "EUR",
        "created_at": "2026-04-01T09:15:00Z",
        "updated_at": "2026-04-12T11:30:00Z"
      },
      "relationships": {
        "created_by": {
          "id": "12345"
        },
        "list": {
          "id": "company_42"
        },
        "custom_feed": {
          "id": "feed-100"
        },
        "campaign_settings": {
          "id": "1234"
        },
        "campaign_summary": {
          "id": "1234"
        },
        "campaign_locations": [
          {
            "id": "98765"
          }
        ]
      }
    }
  ],
  "meta": {
    "pagination": {
      "page_num": 1,
      "page_count": 1,
      "total_count": 1
    },
    "request_id": "cf054205-dd8c-4473-8689-07c30fe0789f"
  }
}