fetch_sweepstakes
Get the sweepstakes associated with your account. Returns a paginated SUMMARY by default (token, name, handler, type, dates, timezone, status, archived, and a computed state). STATE: each item carries state — "scheduled" (not started), "running" (open now), or "ended" (end date already passed) — plus has_ended and days_until_end. ALWAYS read state before giving operational advice: never tell the user to share the entry link or wait for participants on a sweepstakes whose state is "ended". PAGINATION: use page and page_size (default 25, max 100). The response carries pagination.total, total_pages and has_more — if has_more is true, either request the next page or tell the user how many were not shown. NEVER invent sweepstakes that are not in the response. HEAVY PAYLOAD: include_settings: true adds the full Settings object (SMS/email templates, ~1.5 KB each) — only request it when the user asks about entry page settings or message templates, and prefer get_entry_settings for a single sweepstakes. Use tokens internally for tool chaining but present only human-readable information (names, dates, statuses) to the user.
fetch_sweepstakes
When to use
Get the sweepstakes associated with your account. Returns a paginated SUMMARY by default (token, name, handler, type, dates, timezone, status, archived, and a computed state). STATE: each item carries state — "scheduled" (not started), "running" (open now), or "ended" (end date already passed) — plus has_ended and days_until_end. ALWAYS read state before giving operational advice: never tell the user to share the entry link or wait for participants on a sweepstakes whose state is "ended". PAGINATION: use page and page_size (default 25, max 100). The response carries pagination.total, total_pages and has_more — if has_more is true, either request the next page or tell the user how many were not shown. NEVER invent sweepstakes that are not in the response. HEAVY PAYLOAD: include_settings: true adds the full Settings object (SMS/email templates, ~1.5 KB each) — only request it when the user asks about entry page settings or message templates, and prefer get_entry_settings for a single sweepstakes. Use tokens internally for tool chaining but present only human-readable information (names, dates, statuses) to the user.
Parameters to validate before calling
page(number, optional) — range: 1–+∞ — Page number, 1-based. Default: 1.page_size(number, optional) — range: 1–100 — Sweepstakes per page. Default: 25, maximum: 100.include_settings(boolean, optional) — Include the full Settings object of each sweepstakes (heavy: ~1.5 KB each, mostly SMS/email templates). Default: false.include_archived(boolean, optional) — Include archived sweepstakes. Default: true.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number, 1-based. Default: 1. | |
| page_size | No | Sweepstakes per page. Default: 25, maximum: 100. | |
| include_archived | No | Include archived sweepstakes. Default: true. | |
| include_settings | No | Include the full Settings object of each sweepstakes (heavy: ~1.5 KB each, mostly SMS/email templates). Default: false. |