List all stories

GET /v2/stories
Bearer auth

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

Query parameters

  • status string

    Filter stories by status

    Values are Draft, Live, or Archived.

Responses

  • 200 application/json

    Stories retrieved successfully

    Hide response attributes Show response attributes object
    • id string Required

      Unique identifier for the story

    • status string Required

      Current status of the story

      Values are Draft, Live, or Archived.

    • previewUrl string(uri) | null

      Preview URL for the story (null if not published)

    • createdAt string(date-time)

      Timestamp when the story was created

    • title string Required

      Title of the story

    • dynamicVariables object

      Dynamic variables configuration for the story

      Hide dynamicVariables attribute Show dynamicVariables attribute object
      • * object Additional properties
        Hide * attributes Show * attributes object
        • type string

          Type of the variable

        • name string

          Variable name

        • title string

          Display title for the variable

        • default string

          Default value

        • tip string

          Tooltip or help text

        • validation object
          Hide validation attributes Show validation attributes object
          • required boolean
          • errorMessage string
        • mapping string

          Field mapping
  • 403 application/json

    Authentication failed or missing token

    Hide response attribute Show response attribute object
    • error string
  • 404 application/json

    No stories found

    Hide response attribute Show response attribute object
    • error string
  • 429 application/json

    Rate limit exceeded

    Hide headers attributes Show headers attributes
    • x-rate-limit-counter integer

      Current request count

    • x-rate-limit-maximum integer

      Maximum allowed requests

    Hide response attribute Show response attribute object
    • error string
  • 500 application/json

    Internal server error

    Hide response attributes Show response attributes object
    • error string
    • errorId string
GET /v2/stories 
curl \
 --request GET 'https://api.storydoc.com/v2/stories' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
[
  {
    "id": "61b1e50223b713000a41ca74",
    "title": "Sales Presentation Template",
    "status": "Live",
    "createdAt": "2024-01-15T10:30:00.000Z",
    "previewUrl": "https://view.storydoc.com/preview/abc123",
    "dynamicVariables": {
      "company": {
        "tip": "Enter the company name",
        "name": "company",
        "type": "input",
        "title": "Company name",
        "default": "",
        "mapping": "CompanyName",
        "validation": {
          "required": false
        }
      },
      "first_name": {
        "tip": "Prospect's first name",
        "name": "first_name",
        "type": "input",
        "title": "Prospect's first name",
        "default": "",
        "mapping": "FirstName",
        "validation": {
          "required": true,
          "errorMessage": "Required"
        }
      }
    }
  },
  {
    "id": "61b1e50223b713000a41ca75",
    "title": "Product Demo Template",
    "status": "Draft",
    "createdAt": "2024-01-20T14:45:00.000Z",
    "previewUrl": null,
    "dynamicVariables": {
      "features": {
        "tip": "List of product features",
        "name": "features",
        "type": "array",
        "title": "Product Features",
        "default": [],
        "mapping": "Features",
        "validation": {
          "required": false
        }
      },
      "product_name": {
        "tip": "Enter the product name",
        "name": "product_name",
        "type": "input",
        "title": "Product Name",
        "default": "",
        "mapping": "ProductName",
        "validation": {
          "required": true,
          "errorMessage": "Product name is required"
        }
      }
    }
  }
]
Response examples (403) 
{
  "error": "Access denied"
}
Response examples (404) 
{
  "error": "Stories not found"
}
Response examples (429) 
# Headers
x-rate-limit-counter: 42
x-rate-limit-maximum: 42

# Payload
{
  "error": "Too many requests"
}
Response examples (500) 
{
  "error": "Error occured",
  "errorId": "550e8400-e29b-41d4-a716-446655440000"
}