> ## Documentation Index
> Fetch the complete documentation index at: https://developers.redo.com/llms.txt
> Use this file to discover all available pages before exploring further.
# campaigns
> List campaigns, optionally filtered by name, channel, or when they finished sending.
**Required scopes:** [`campaigns_read`](/docs/api-reference/v3/reference/scopes#scope-campaigns_read)
## Arguments
Forward pagination cursor — returns items after it. Pass an `edges[].cursor` or `pageInfo.endCursor` from a previous page.
Backward pagination cursor — returns items before it. Pass an `edges[].cursor` or `pageInfo.startCursor` from a previous page.
MarketingChannel}>
Only include campaigns sending on this channel.
Forward pagination: returns the first N items (max 100, default 25). Use with `after`; mutually exclusive with `last`/`before`.
Backward pagination: returns the last N items (max 100, default 25). Use with `before`; mutually exclusive with `first`/`after`.
CampaignSortKey}>
Which key to sort by (defaults to the first key, newest-first). Combine with `reverse` to flip direction.
Case-insensitive substring match on the campaign name. At most 200 characters.
Reverses the sort direction selected by `orderBy` (or its default).
DateTime}>
Only include campaigns that finished sending at or after this ISO-8601 instant.
DateTime}>
Only include campaigns that finished sending before this ISO-8601 instant.
## Returns
CampaignConnection!} required>
A paginated list of Campaign items.
[CampaignEdge!]!} required>
The list of edges (each a node plus its pagination `cursor`).
Opaque cursor for this item; pass to `after`/`before` to page from here.
Campaign!} required>
The item at this edge.
CampaignAnalytics!} required>
Analytics for this campaign, grouped by what is being measured.
DateTime}>
When the merchant canceled the campaign, if they did.
MarketingChannel!} required>
The channel this campaign sends on.
DateTime!} required>
When the campaign was created.
[CampaignEmailVariant!]!} required>
The email content this campaign sends, oldest arm first. A campaign that is not split-testing has exactly one entry; there is no separate `subject` on the campaign because a split test has more than one.
CampaignErrorCode}>
Why the campaign failed, when it did.
[Segment!]!} required>
The segments held out of this campaign.
**Requires:** [`segments_read`](/docs/api-reference/v3/reference/scopes#scope-segments_read)
DateTime}>
When the campaign failed to send, if it did.
CampaignFollowUpConfig}>
Follow-up email configuration when one was enabled.
EmailAddress}>
The from address recorded when the campaign sent. Null for drafts and for SMS campaigns.
EmailSender}>
The From mailbox chosen for this campaign. Null when the store default should be used, and for SMS.
**Requires:** [`campaigns_read`](/docs/api-reference/v3/reference/scopes#scope-campaigns_read)
The id of this campaign.
The campaign's legacy Mongo ObjectId (24-char hex) from before the CockroachDB migration.
The merchant-facing name of the campaign.
EmailAddress}>
The reply-to address recorded when the campaign sent. Null when none was set.
EmailSender}>
The Reply-To mailbox chosen for this campaign. Null when the store default should be used.
**Requires:** [`campaigns_read`](/docs/api-reference/v3/reference/scopes#scope-campaigns_read)
DateTime}>
When the campaign is scheduled to start sending. Null for drafts, and for campaigns scheduled in each recipient's local time.
IANA time zone the merchant picked when scheduling a single UTC instant. Null for drafts and local-time sends.
IANA time zone used when a recipient has no time zone, for local-time sends. Null when `scheduledAt` is set.
For campaigns scheduled in each recipient's local time, the wall-clock time they send at, as `YYYY-MM-DDTHH:mm:ss`. Null when `scheduledAt` is set.
[Segment!]!} required>
The segments this campaign was sent to.
**Requires:** [`segments_read`](/docs/api-reference/v3/reference/scopes#scope-segments_read)
DateTime}>
When the campaign finished sending. Null until it has finished.
[CampaignSmsVariant!]!} required>
The SMS content this campaign sends, oldest arm first. Empty for email campaigns.
CampaignStatus!} required>
Derived lifecycle status from schedule, send, failure, and cancellation timestamps.
Tags the merchant applied to this campaign, in the order they applied them. Free-form and merchant-defined — Redo attaches no meaning to them, so they are the place a store's own categorisation (a promotion name, a season, a product line) is kept. Empty when the campaign is untagged.
DateTime!} required>
When the campaign was last updated.
[Campaign!]!} required>
The nodes in this page, without the edge/cursor wrapper — a convenience over `edges`.
CampaignAnalytics!} required>
Analytics for this campaign, grouped by what is being measured.
CampaignMessagingAnalytics!} required>
Email and SMS performance, read from the analytics warehouse: what was sent, how it was engaged with, and the orders and revenue attributed to it.
**Requires:** [`campaigns_analytics_read`](/docs/api-reference/v3/reference/scopes#scope-campaigns_analytics_read)
**Arguments**
How many days after a message an order still counts toward it, 1-30.
Date!} required>
Last day to report on, inclusive, in the store's timezone. The range may span at most 400 days.
Date!} required>
First day to report on, inclusive, in the store's timezone. Must be on or before `endDate`, and the range may span at most 400 days.
DateTime}>
When the merchant canceled the campaign, if they did.
MarketingChannel!} required>
The channel this campaign sends on.
DateTime!} required>
When the campaign was created.
[CampaignEmailVariant!]!} required>
The email content this campaign sends, oldest arm first. A campaign that is not split-testing has exactly one entry; there is no separate `subject` on the campaign because a split test has more than one.
The share of recipients this variant was sent to. A campaign with a single variant weights it 1.
This variant's position within the campaign, starting at 0. Stable, so it names an arm of a split test across reports.
EmailTemplate}>
The content this variant sent. Null when the template has since been deleted.
**Requires:** [`marketing_templates_read`](/docs/api-reference/v3/reference/scopes#scope-marketing_templates_read)
CampaignErrorCode}>
Why the campaign failed, when it did.
[Segment!]!} required>
The segments held out of this campaign.
**Requires:** [`segments_read`](/docs/api-reference/v3/reference/scopes#scope-segments_read)
JSON}>
Dynamic segment condition tree. Null for static and persona segments.
DateTime}>
When the member counts were last recalculated. They are not live.
DateTime!} required>
When the segment was created.
The merchant's description of who this segment is for.
Members subscribed to email marketing as of `countsRefreshedAt`.
The id of this segment.
The segment's legacy Mongo ObjectId (24-char hex) from before the CockroachDB migration.
Customers in the segment as of `countsRefreshedAt`. Null until it has first been counted.
The merchant-facing name of the segment.
Members subscribed to SMS marketing as of `countsRefreshedAt`.
SegmentType!} required>
How membership of this segment is determined.
DateTime!} required>
When the segment was last updated.
DateTime}>
When the campaign failed to send, if it did.
CampaignFollowUpConfig}>
Follow-up email configuration when one was enabled.
Delay after the original send before the follow-up goes out.
Whether a follow-up send is configured.
CampaignFollowUpEngagementPeriod}>
Engagement window, in days, used to pick recipients.
Legacy Mongo ObjectId of the campaign this follow-up was created from.
Subject line for the follow-up email.
EmailAddress}>
The from address recorded when the campaign sent. Null for drafts and for SMS campaigns.
The mailbox address.
The display name shown alongside the address.
EmailSender}>
The From mailbox chosen for this campaign. Null when the store default should be used, and for SMS.
**Requires:** [`campaigns_read`](/docs/api-reference/v3/reference/scopes#scope-campaigns_read)
DateTime!} required>
When the address was added.
The mailbox address.
The id of this sender address. Pass it to `updateCampaign`.
The display name shown alongside the address.
The id of this campaign.
The campaign's legacy Mongo ObjectId (24-char hex) from before the CockroachDB migration.
The merchant-facing name of the campaign.
EmailAddress}>
The reply-to address recorded when the campaign sent. Null when none was set.
The mailbox address.
The display name shown alongside the address.
EmailSender}>
The Reply-To mailbox chosen for this campaign. Null when the store default should be used.
**Requires:** [`campaigns_read`](/docs/api-reference/v3/reference/scopes#scope-campaigns_read)
DateTime!} required>
When the address was added.
The mailbox address.
The id of this sender address. Pass it to `updateCampaign`.
The display name shown alongside the address.
DateTime}>
When the campaign is scheduled to start sending. Null for drafts, and for campaigns scheduled in each recipient's local time.
IANA time zone the merchant picked when scheduling a single UTC instant. Null for drafts and local-time sends.
IANA time zone used when a recipient has no time zone, for local-time sends. Null when `scheduledAt` is set.
For campaigns scheduled in each recipient's local time, the wall-clock time they send at, as `YYYY-MM-DDTHH:mm:ss`. Null when `scheduledAt` is set.
[Segment!]!} required>
The segments this campaign was sent to.
**Requires:** [`segments_read`](/docs/api-reference/v3/reference/scopes#scope-segments_read)
JSON}>
Dynamic segment condition tree. Null for static and persona segments.
DateTime}>
When the member counts were last recalculated. They are not live.
DateTime!} required>
When the segment was created.
The merchant's description of who this segment is for.
Members subscribed to email marketing as of `countsRefreshedAt`.
The id of this segment.
The segment's legacy Mongo ObjectId (24-char hex) from before the CockroachDB migration.
Customers in the segment as of `countsRefreshedAt`. Null until it has first been counted.
The merchant-facing name of the segment.
Members subscribed to SMS marketing as of `countsRefreshedAt`.
SegmentType!} required>
How membership of this segment is determined.
DateTime!} required>
When the segment was last updated.
DateTime}>
When the campaign finished sending. Null until it has finished.
[CampaignSmsVariant!]!} required>
The SMS content this campaign sends, oldest arm first. Empty for email campaigns.
The share of recipients this variant was sent to. A campaign with a single variant weights it 1.
This variant's position within the campaign, starting at 0.
SmsTemplate}>
The content this variant sent. Null when the template has since been deleted.
**Requires:** [`marketing_templates_read`](/docs/api-reference/v3/reference/scopes#scope-marketing_templates_read)
CampaignStatus!} required>
Derived lifecycle status from schedule, send, failure, and cancellation timestamps.
Tags the merchant applied to this campaign, in the order they applied them. Free-form and merchant-defined — Redo attaches no meaning to them, so they are the place a store's own categorisation (a promotion name, a season, a product line) is kept. Empty when the campaign is untagged.
DateTime!} required>
When the campaign was last updated.
PageInfo!} required>
Pagination metadata for the current page.
Cursor of the last edge in this page; pass to `after` to page forward.
Whether more items exist after this page (drives forward pagination with `first`/`after`).
Whether more items exist before this page (drives backward pagination with `last`/`before`).
Cursor of the first edge in this page; pass to `before` to page backward.
## Example
```graphql theme={null}
query {
campaigns(after: "...", before: "...", channel: EMAIL, first: 10, last: 10, orderBy: CREATED_AT, query: "...", reverse: true, sentAfter: "...", sentBefore: "...") {
nodes {
canceledAt
channel
createdAt
errorCode
failedAt
id
legacyId
name
# ...
}
pageInfo { hasNextPage endCursor }
}
}
```
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.