> ## Documentation Index
> Fetch the complete documentation index at: https://code.dcycle.io/llms.txt
> Use this file to discover all available pages before exploring further.

# List Campaigns

> List all campaigns within a dataset with aggregated stats

# List Campaigns

Retrieve all campaigns within a dataset. Each campaign is enriched with aggregate counts: total recipients, responses received, and completed assignments.

## Request

### Headers

<ParamField header="x-api-key" type="string" required>
  Your API key for authentication

  **Example:** `sk_live_1234567890abcdef`
</ParamField>

<ParamField header="x-organization-id" type="string" required>
  Your organization UUID

  **Example:** `a8315ef3-dd50-43f8-b7ce-d839e68d51fa`
</ParamField>

### Path Parameters

<ParamField path="dataset_id" type="string" required>
  UUID of the parent dataset
</ParamField>

## Response

Returns an array of campaign objects with aggregate stats (HTTP 200).

<ResponseField name="id" type="string">UUID</ResponseField>
<ResponseField name="name" type="string">Campaign name</ResponseField>
<ResponseField name="period_start" type="string">Reporting period start (ISO date)</ResponseField>
<ResponseField name="period_end" type="string">Reporting period end (ISO date)</ResponseField>
<ResponseField name="deadline" type="string">Submission deadline (ISO date)</ResponseField>
<ResponseField name="locked_at" type="string">Lock timestamp (nullable)</ResponseField>
<ResponseField name="recipient_count" type="integer">Total assigned recipients</ResponseField>
<ResponseField name="response_count" type="integer">Total responses received</ResponseField>
<ResponseField name="completed_count" type="integer">Recipients who completed all KPIs</ResponseField>
<ResponseField name="recipients_preview" type="array">First few recipients (email + user\_id)</ResponseField>

## Example

<CodeGroup>
  ```bash cURL theme={"theme":{"light":"github-light","dark":"github-dark"}}
  curl -X GET "https://api.dcycle.io/v1/custom-kpi-datasets/${DATASET_ID}/campaigns" \
    -H "x-api-key: ${DCYCLE_API_KEY}" \
    -H "x-organization-id: ${DCYCLE_ORG_ID}"
  ```

  ```python Python theme={"theme":{"light":"github-light","dark":"github-dark"}}
  import requests
  import os

  headers = {
      "x-api-key": os.getenv("DCYCLE_API_KEY"),
      "x-organization-id": os.getenv("DCYCLE_ORG_ID"),
  }

  dataset_id = "a1b2c3d4-e5f6-7890-abcd-ef1234567890"

  response = requests.get(
      f"https://api.dcycle.io/v1/custom-kpi-datasets/{dataset_id}/campaigns",
      headers=headers,
  )

  for c in response.json():
      print(f"{c['name']}: {c['completed_count']}/{c['recipient_count']} complete")
  ```

  ```javascript JavaScript theme={"theme":{"light":"github-light","dark":"github-dark"}}
  const axios = require('axios');

  const headers = {
    'x-api-key': process.env.DCYCLE_API_KEY,
    'x-organization-id': process.env.DCYCLE_ORG_ID,
  };

  const datasetId = 'a1b2c3d4-e5f6-7890-abcd-ef1234567890';

  axios.get(`https://api.dcycle.io/v1/custom-kpi-datasets/${datasetId}/campaigns`, { headers })
    .then(response => {
      response.data.forEach(c => console.log(`${c.name}: ${c.completed_count}/${c.recipient_count}`));
    });
  ```
</CodeGroup>

### Successful Response

```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
[
  {
    "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
    "dataset_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "name": "Q1 2025 Water Survey",
    "period_start": "2025-01-01",
    "period_end": "2025-03-31",
    "deadline": "2025-04-15",
    "locked_at": null,
    "created_by": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
    "created_at": "2025-01-10T08:00:00Z",
    "updated_at": null,
    "recipient_count": 5,
    "response_count": 12,
    "completed_count": 3,
    "recipients_preview": [
      {"data_owner_user_id": null, "data_owner_email": "manager-a@example.com"},
      {"data_owner_user_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479", "data_owner_email": "manager-b@example.com"}
    ]
  }
]
```

## Common Errors

### 401 Unauthorized

**Cause:** Missing or invalid API key

```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{"detail": "Invalid API key for organization", "code": "INVALID_API_KEY"}
```

### 403 Forbidden

**Cause:** The authenticated user is not a member of the organization

```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{"detail": "Logged User is not Member of Organization", "code": "LOGGED_USER_NOT_MEMBER"}
```

### 404 Not Found

**Cause:** The dataset does not exist or belongs to another organization

```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{"detail": "Not Found"}
```

## Related Endpoints

<CardGroup cols={2}>
  <Card title="Create Campaign" icon="plus" href="/api-reference/custom-kpi/create-campaign">
    Create a new collection campaign
  </Card>

  <Card title="Get Campaign" icon="magnifying-glass" href="/api-reference/custom-kpi/get-campaign">
    View campaign details with recipients
  </Card>
</CardGroup>