STstorydoc
stories

Get story details

Retrieves detailed information about a specific story including its settings and dynamic variables

get/v2/stories/{storyId}

Request

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

Path parameters

storyIdstring required
Example:61b1e50223b713000a41ca74

The ID of the story to retrieve

Query parameters

include'optionalContent'

optionalContent adds the story's optional content (see OptionalEntity). Reads the story's content file, so only ask when needed. Always included on GET /v2/stories/{storyId}/variables.

Response

Story details 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.