---
title: "Get Campaign"
method: GET
path: "/shop/customers/campaigns/{campaignId}"
tags: ["Campaigns"]
---

# Get Campaign

`GET /shop/customers/campaigns/{campaignId}`

Returns the `Campaign` with the given ID.

## Response `200`

The campaign was successfully retrieved.

- object
  - `data` Campaign, required — An email marketing campaign sent to the members of a `CustomerSegment`. A campaign can be scheduled in advance and tracks when it was sent.
    - `id` string, uuid, required — The unique identifier of the campaign.
    - `name` string, required — The display name of the campaign.
    - `progress` number, float, nullable, required — The send progress of the campaign as a percentage (0–100). Only populated when `status` is `in_progress`; `null` otherwise.
    - `scheduled_at` string, date-time, nullable, required — The datetime at which this campaign is scheduled to be sent, or `null` if not yet scheduled.
    - `segment` object, nullable, required — A summary of the `CustomerSegment` this campaign is targeting, or `null` if no segment has been assigned.
      - `id` string, uuid, required — The ID of the segment.
      - `name` string, required — The display name of the segment.
    - `sent_at` string, date-time, nullable, required — The datetime at which this campaign was sent, or `null` if it has not yet been sent.
    - `site_id` string, uuid, required
    - `status` 'unsent' | 'in_progress' | 'sent', required — The current send status of the campaign. - `unsent` — no send records exist yet. - `in_progress` — sends have been created but at least one has not yet been sent. - `sent` — all send records have been sent.

## Other responses

- `401` — The user is unauthenticated
- `403` — The authenticated user does not have permission.
- `404` — The resource couldn't be found

---

[API](https://skmtc.dev/try/apis/trybe-api.md) · [All operations](https://skmtc.dev/try/apis/trybe-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/try/trybe-api/revisions/f37f92702da5/schema)
