STstorydoc
versions

List versions

Lists the versions in your organization, newest first - the same versions the Versions tab shows to the person who created the API key: versions of Live stories in folders they can open (or in no folder), with each story's primary version left out. An administrator's key sees every folder. Every row carries the version's status (Live, Expired, Draft or Accepted, derived exactly as in the Versions tab), its story, the story's folder and the sender. Use it to find versions nobody has opened yet, or poll it with dateField=updatedAt&dateFrom=<last sync> to pick up changes (edits and acceptances update updatedAt; expiry does not - it follows from expireAt). A key scoped to one story only ever lists that story's versions. Variable values are not included; fetch one version with GET /v2/versions/{versionId} for those.

get/v2/versions

Request

  • Base URL
    https://api.storydoc.com
  • Auth
    HTTP bearer

Query parameters

storyIdstring
Example:61b1e50223b713000a41ca74

Only versions created from this story (template). Must be a Live story.

folderIdstring
Example:64f1c2a9e1b2c3d4e5f60718

Only versions whose story is in this folder or any folder under it - the Versions tab's Location filter. A version sits in its story's folder. Folder ids come from GET /v2/folders. 404 if the folder does not exist.

senderEmailstring email
Example:sender@company.com

Only versions sent by this user of your organization

titlestring
Example:ACME

Only versions whose title contains this text (case-insensitive, at most 200 characters)

statusstring
Example:Live,Accepted

Comma-separated list of statuses to include

hasAcceptButtonboolean

true: only proposals - versions with an Accept button. false: only versions without one. Combine with status for open proposals: hasAcceptButton=true&status=Live.

dateField'createdAt' | 'updatedAt'

Which date dateFrom/dateTo apply to

dateFromstring
Example:2026-10-01

Inclusive start (ISO 8601, UTC)

dateTostring
Example:2026-10-31

Inclusive end (ISO 8601, UTC). A date without a time covers that whole day.

pageinteger

1-based page number

pageSizeinteger

Versions per page

Response

A page of versions

Example response

{
  "data": [
    {
      "id": "61b1f40a3a86b7a96d0d8ccc",
      "title": "ACME - Proposal",
      "storyId": "61b1e50223b713000a41ca74",
      "storyTitle": "Proposal template",
      "folder": {
        "name": "Enterprise",
        "path": [
          "Sales",
          "Enterprise"
        ],
        "members": [
          {
            "name": "Dana Lee",
            "email": "dana@company.com"
          }
        ]
      },
      "sender": {
        "name": "Dana Lee",
        "email": "dana@company.com"
      },
      "shortUrl": "https://view.storydoc.com/4GdDGt"
    }
  ],
  "pagination": {
    "page": 1,
    "pageSize": 25
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.