> ## 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.

# Get Campaign

> Retrieve a campaign with its recipients and their statuses

# Get Campaign

Retrieve a campaign including all campaign-assignments (recipients) with their derived statuses: `awaiting`, `completed`, or `locked`.

## 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>

<ParamField path="campaign_id" type="string" required>
  UUID of the campaign
</ParamField>

## Response

Returns the campaign with nested `campaign_assignments` array (HTTP 200).

<ResponseField name="id" type="string">
  Campaign UUID.
</ResponseField>

<ResponseField name="dataset_id" type="string">
  UUID of the parent dataset this campaign belongs to.
</ResponseField>

<ResponseField name="name" type="string">
  Campaign display name.
</ResponseField>

<ResponseField name="period_start" type="string">
  Data collection period start date (ISO 8601 date).
</ResponseField>

<ResponseField name="period_end" type="string">
  Data collection period end date (ISO 8601 date).
</ResponseField>

<ResponseField name="deadline" type="string">
  Deadline for recipients to submit responses (ISO 8601 date).
</ResponseField>

<ResponseField name="locked_at" type="string | null">
  Timestamp when the campaign was locked. `null` if still open.
</ResponseField>

<ResponseField name="created_by" type="string | null">
  UUID of the user who created the campaign.
</ResponseField>

<ResponseField name="updated_by" type="string | null">
  UUID of the user who last updated the campaign.
</ResponseField>

<ResponseField name="created_at" type="datetime">
  Creation timestamp (ISO 8601).
</ResponseField>

<ResponseField name="updated_at" type="string | null">
  Last update timestamp (ISO 8601).
</ResponseField>

<ResponseField name="campaign_assignments" type="array[object]">
  Recipients assigned to this campaign with their completion status.

  <Expandable title="Campaign Assignment Object">
    <ResponseField name="id" type="string">
      Campaign-assignment UUID.
    </ResponseField>

    <ResponseField name="campaign_id" type="string">
      Parent campaign UUID.
    </ResponseField>

    <ResponseField name="assignment_id" type="string">
      Underlying dataset assignment UUID.
    </ResponseField>

    <ResponseField name="last_invited_at" type="string | null">
      When the invite email was last sent.
    </ResponseField>

    <ResponseField name="completed_at" type="string | null">
      When the recipient completed all KPIs. `null` if pending.
    </ResponseField>

    <ResponseField name="status" type="string">
      Derived status: `awaiting`, `completed`, or `locked`.
    </ResponseField>

    <ResponseField name="assignment" type="object">
      Embedded dataset assignment with recipient details.

      <Expandable title="Assignment Object">
        <ResponseField name="id" type="string">
          Assignment UUID.
        </ResponseField>

        <ResponseField name="dataset_id" type="string">
          Parent dataset UUID.
        </ResponseField>

        <ResponseField name="organization_id" type="string">
          Organization UUID the assignment targets.
        </ResponseField>

        <ResponseField name="facility_id" type="string | null">
          Facility UUID if the assignment is facility-scoped.
        </ResponseField>

        <ResponseField name="data_owner_user_id" type="string | null">
          User UUID of the data owner (if they have a Dcycle account).
        </ResponseField>

        <ResponseField name="data_owner_email" type="string">
          Email address of the recipient.
        </ResponseField>

        <ResponseField name="created_at" type="datetime">
          Creation timestamp (ISO 8601).
        </ResponseField>

        <ResponseField name="updated_at" type="string | null">
          Last update timestamp (ISO 8601).
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="created_at" type="datetime">
      Creation timestamp (ISO 8601).
    </ResponseField>

    <ResponseField name="updated_at" type="string | null">
      Last update timestamp (ISO 8601).
    </ResponseField>
  </Expandable>
</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/${CAMPAIGN_ID}" \
    -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"
  campaign_id = "b2c3d4e5-f6a7-8901-bcde-f12345678901"

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

  campaign = response.json()
  for ca in campaign["campaign_assignments"]:
      print(f"  {ca['assignment']['data_owner_email']}: {ca['status']}")
  ```

  ```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';
  const campaignId = 'b2c3d4e5-f6a7-8901-bcde-f12345678901';

  axios.get(`https://api.dcycle.io/v1/custom-kpi-datasets/${datasetId}/campaigns/${campaignId}`, { headers })
    .then(response => {
      response.data.campaign_assignments.forEach(ca =>
        console.log(`${ca.assignment.data_owner_email}: ${ca.status}`)
      );
    });
  ```
</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": "c3d4e5f6-a7b8-9012-cdef-345678901234",
  "updated_by": null,
  "created_at": "2025-06-15T10:00:00Z",
  "updated_at": null,
  "campaign_assignments": [
    {
      "id": "f1a2b3c4-d5e6-7890-abcd-ef1234567890",
      "campaign_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
      "assignment_id": "d4e5f6a7-b8c9-0123-defa-234567890123",
      "last_invited_at": "2025-06-16T09:00:00Z",
      "completed_at": null,
      "status": "awaiting",
      "assignment": {
        "id": "d4e5f6a7-b8c9-0123-defa-234567890123",
        "dataset_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "organization_id": "a8315ef3-dd50-43f8-b7ce-d839e68d51fa",
        "facility_id": null,
        "data_owner_user_id": null,
        "data_owner_email": "supplier@example.com",
        "created_at": "2025-06-10T08:00:00Z",
        "updated_at": null
      },
      "created_at": "2025-06-15T10:00:00Z",
      "updated_at": null
    },
    {
      "id": "a2b3c4d5-e6f7-8901-abcd-ef2345678901",
      "campaign_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
      "assignment_id": "e5f6a7b8-c9d0-1234-efab-345678901234",
      "last_invited_at": "2025-06-16T09:00:00Z",
      "completed_at": "2025-06-20T14:30:00Z",
      "status": "completed",
      "assignment": {
        "id": "e5f6a7b8-c9d0-1234-efab-345678901234",
        "dataset_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "organization_id": "a8315ef3-dd50-43f8-b7ce-d839e68d51fa",
        "facility_id": "660e8400-e29b-41d4-a716-446655440000",
        "data_owner_user_id": "b9f1e2d3-0000-0000-0000-000000000001",
        "data_owner_email": "ana.garcia@company.com",
        "created_at": "2025-06-10T08:00:00Z",
        "updated_at": null
      },
      "created_at": "2025-06-15T10:00:00Z",
      "updated_at": null
    }
  ]
}
```

## 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:** Campaign not found

```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
  "detail": "Campaign not found"
}
```

## Related Endpoints

<CardGroup cols={2}>
  <Card title="Update Campaign" icon="pencil" href="/api-reference/custom-kpi/update-campaign">
    Change campaign name or dates
  </Card>

  <Card title="Send Invites" icon="paper-plane" href="/api-reference/custom-kpi/send-invites">
    Notify recipients
  </Card>
</CardGroup>