---
title: "Preview a public Calendar snapshot"
method: POST
path: "/v1/workspaces/{workspaceId}/calendar/snapshots/preview"
tags: ["Calendar"]
---

# Preview a public Calendar snapshot

`POST /v1/workspaces/{workspaceId}/calendar/snapshots/preview`

## Request

- Base URL: `https://api.maevesocial.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.maevesocial.com/v1/workspaces/{workspaceId}/calendar/snapshots/preview`
- Auth: HTTP bearer

## Path parameters

- `workspaceId` string, uuid, required

## Request body

- PreviewCalendarShareDto
  - `settings` CalendarShareSettingsDto, required
    - `version` 1, required
    - `title` string, required
    - `dateRange` CalendarShareDateRangeDto, required
      - `start` string, required
      - `end` string, required
    - `filters` CalendarShareFiltersDto, required
      - `integrationIds` string[], nullable
      - `platforms` string[], nullable
      - `statuses` string[], required
      - `campaignIds` string[], nullable
      - `labelIds` string[], nullable
      - `pillarIds` string[], nullable
      - `formatIds` string[], nullable
      - `includePostedHistory` boolean, required
      - `includeScheduledFuture` boolean, required
      - `includeReviewItems` boolean, required
      - `includeDrafts` boolean, required
      - `includeCalendarNotes` boolean, required
    - `include` CalendarShareIncludeDto, required
      - `captions` boolean, required
      - `media` boolean, required
      - `postTitles` boolean, required
      - `firstComments` boolean, required
      - `threadPosts` boolean, required
      - `accountNames` boolean, required
      - `accountAvatars` boolean, required
      - `highLevelApprovalState` boolean, required
      - `exactPublishTimes` boolean, required
      - `labels` boolean, required
      - `pillars` boolean, required
      - `formats` boolean, required

## Response `201`

Calendar result

- object
  - `data` PublicCalendarSharePreviewDto, required
    - `counts` object, required
      - `posts` number, required
      - `notes` number, required
      - `excludedDraftsWithoutDate` number, required
      - `truncated` boolean, required
    - `settingsSummary` object, required
      - `dateRange` object, required
        - `start` string, date-time, required
        - `end` string, date-time, required
      - `statuses` string[], required
      - `include` object, required
        - `captions` boolean, required
        - `media` boolean, required
        - `postTitles` boolean, required
        - `firstComments` boolean, required
        - `threadPosts` boolean, required
        - `accountNames` boolean, required
        - `accountAvatars` boolean, required
        - `highLevelApprovalState` boolean, required
        - `exactPublishTimes` boolean, required
        - `labels` boolean, required
        - `pillars` boolean, required
        - `formats` boolean, required
      - `filters` object, required
        - `integrationCount` number, required
        - `platformCount` number, required
        - `campaignCount` number, required
        - `labelCount` number, required
        - `pillarCount` number, required
        - `formatCount` number, required
    - `warnings` object[], required
      - `code` 'no_posts' | 'drafts_included' | 'calendar_notes_included' | 'taxonomy_included' | 'snapshot_truncated' | 'drafts_without_date_excluded', required
      - `message` string, required
  - `meta` unknown, required

---

[API](https://skmtc.dev/maevesocial/apis/maeve-social-api.md) · [All operations](https://skmtc.dev/maevesocial/apis/maeve-social-api/llms.txt) · [OpenAPI document](https://skmtc.dev/maevesocial/apis/maeve-social-api/revisions/1b00fd7e4b15?raw)