stories

List all stories

Retrieves a list of all stories in the organization with optional status filtering

get/v2/stories

Request

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

Query parameters

status'Draft' | 'Live' | 'Archived'
Example:Live

Filter stories by status

Response

Stories retrieved successfully

idstring required

Unique identifier for the story

status'Draft' | 'Live' | 'Archived' required

Current status of the story

previewUrlstring uri nullable

Preview URL for the story (null if not published)

createdAtstring date-time

Timestamp when the story was created

titlestring required

Title of the story

dynamicVariablesobject

Dynamic variables configuration for the story

Example response

[
  {
    "optionalContent": [
      {
        "id": "Xk2pQ9rLm4Tz7aBcD1eF",
        "name": "Pricing",
        "type": "slide",
        "slideIndex": 4,
        "slideTitle": "Pricing",
        "rule": {
          "variable": "industry",
          "value": "Retail"
        }
      }
    ],
    "repeatables": [
      {
        "key": "team",
        "name": "Team members",
        "fields": [
          {
            "key": "name",
            "name": "Name",
            "type": "input"
          }
        ]
      }
    ],
    "id": "61b1e50223b713000a41ca74",
    "status": "Live",
    "previewUrl": "https://view.storydoc.com/preview/abc123",
    "createdAt": "2024-01-15T10:30:00.000Z",
    "title": "Sales Presentation Template",
    "dynamicVariables": {
      "first_name": {
        "type": "input",
        "name": "first_name",
        "title": "Prospect's first name",
        "default": "",
        "tip": "Prospect's first name",
        "validation": {
          "required": true,
          "errorMessage": "Required"
        },
        "mapping": "FirstName"
      },
      "company": {
        "type": "input",
        "name": "company",
        "title": "Company name",
        "default": "",
        "tip": "Enter the company name",
        "validation": {
          "required": false
        },
        "mapping": "CompanyName"
      }
    }
  }
]

Changes

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