v1

latestOpenAPI 3.0.02026-07-14422039.0 KB
Story

Story: Get by Id

Returns story metadata, inlcuding json object with story outline

get/{id}

Path parameters

idstring uuid required

the id from the story object

Query parameters

include_relationshipsboolean

Indicate whether the returned object should include child relationships

include_outlineboolean

Determines whether a repsonse including story objects should include the story outline. Defaults to true. Useful for speeding up processing times.

fullboolean

Pull a story object with associated collaborator user, permission, and session data(faster if cached from prior api call)

refresh_cacheboolean

Force the api reload the Story full object

Response

Success responses with story object

created_atstring date-time
created_bystring uuid
idstring uuid
updated_atstring date-time
updated_bystring uuid
is_publicboolean
outlinestring nullable
revisioninteger
titlestring