guide

Export guide content

Retrieves the full structure of a guide, including steps, transitions, and metadata.

get/guide/export

Request

Base URL
https://public.stonly.com/api/v3
Auth
HTTP basic

Query parameters

teamIdinteger

ID of the team to manage. Optional if the API key is associated with a single team.

contentIdstring required

Example:ioTkq4uNhy

Unique guide identifier (referred to as contentId in exports).

language'am' | 'ar' | 'bg' | 'bn' | 'bs' | 'ca' | 'cn' | 'cs' | 'cy' | 'da' | 'de' | 'de-AT' | 'de-CH' | 'el' | 'en' | 'en-GB' | 'en-US' | 'es' | 'es-CL' | 'es-EC' | 'et' | 'eu' | 'fa' | 'fi' | 'fr' | 'fr-BE' | 'fr-CA' | 'ga' | 'gd' | 'he' | 'hi' | 'hr' | 'hu' | 'hy' | 'id' | 'is' | 'it' | 'ja' | 'ka' | 'kn' | 'ko' | 'lt' | 'lv' | 'mi' | 'mk' | 'nb' | 'nl' | 'nl-BE' | 'nn' | 'no' | 'pl' | 'pt' | 'pt-BR' | 'ro' | 'ru' | 'sk' | 'sl' | 'sq' | 'sr' | 'sv' | 'sw' | 'th' | 'tl' | 'tr' | 'uk' | 'ur' | 'vi' | 'zh' | 'zh-Hant'

The ISO 639-1 language code (with some regional variants). Supported values map as follows:

|---|---|---|---|---|---| | am | Amharic | ar | Arabic | bg | Bulgarian | | bn | Bengali | bs | Bosnian | ca | Catalan | | cn | Montenegrin | cs | Czech | cy | Welsh | | da | Danish | de | German | de-AT | German (Austria) | | de-CH | German (Switzerland) | el | Greek | en | English | | en-GB | English (UK) | en-US | English (US) | es | Spanish | | es-CL | Spanish (Chile) | es-EC | Spanish (Ecuador) | et | Estonian | | eu | Basque | fa | Persian | fi | Finnish | | fr | French | fr-BE | French (Belgium) | fr-CA | French (Canada) | | ga | Irish | gd | Scots Gaelic | he | Hebrew | | hi | Hindi | hr | Croatian | hu | Hungarian | | hy | Armenian | id | Indonesian | is | Icelandic | | it | Italian | ja | Japanese | ka | Georgian | | kn | Kannada | ko | Korean | lt | Lithuanian | | lv | Latvian | mi | Maori | mk | Macedonian | | nb | Norwegian Bokmål | nl | Dutch | nl-BE | Flemish | | nn | Norwegian Nynorsk | no | Norwegian | pl | Polish | | pt | Portuguese | pt-BR | Portuguese (Brazil) | ro | Romanian | | ru | Russian | sk | Slovak | sl | Slovenian | | sq | Albanian | sr | Serbian | sv | Swedish | | sw | Swahili | th | Thai | tl | Tagalog (Filipino) | | tr | Turkish | uk | Ukrainian | ur | Urdu | | vi | Vietnamese | zh | Chinese (Simplified) | zh-Hant | Chinese (Traditional) |

Language version to export. If omitted, the default language is used. Supported values:

Code	Language	Code	Language	Code	Language
af	Afrikaans	sq	Albanian	am	Amharic
ar	Arabic	hy	Armenian	az	Azerbaijani
eu	Basque	be	Belarusian	bn	Bengali
bs	Bosnian	bg	Bulgarian	ca	Catalan
ceb	Cebuano	zh	Chinese (Simplified)	zh-Hant	Chinese (Traditional)
co	Corsican	hr	Croatian	cs	Czech
da	Danish	nl	Dutch	en	English
en-GB	English (UK)	en-US	English (US)	eo	Esperanto
et	Estonian	fi	Finnish	fr	French
fr-BE	French (Belgium)	fr-CA	French (Canada)	fy	Frisian
gl	Galician	ka	Georgian	de	German
de-AT	German (Austria)	el	Greek	gu	Gujarati
ht	Haitian Creole	ha	Hausa	haw	Hawaiian
he	Hebrew	hi	Hindi	hmn	Hmong
hu	Hungarian	is	Icelandic	ig	Igbo
id	Indonesian	ga	Irish	it	Italian
ja	Japanese	jv	Javanese	kn	Kannada
kk	Kazakh	km	Khmer	rw	Kinyarwanda
ko	Korean	ku	Kurdish	ky	Kyrgyz
lo	Lao	lv	Latvian	lt	Lithuanian
lb	Luxembourgish	mk	Macedonian	mg	Malagasy
ms	Malay	ml	Malayalam	mt	Maltese
mi	Maori	mr	Marathi	mn	Mongolian
my	Myanmar (Burmese)	nb	Norwegian Bokmål	ne	Nepali
nn	Norwegian Nynorsk	no	Norwegian	ny	Nyanja (Chichewa)
or	Odia (Oriya)	ps	Pashto	fa	Persian
pl	Polish	pt	Portuguese	pa	Punjabi
ro	Romanian	ru	Russian	sm	Samoan
gd	Scots Gaelic	sr	Serbian	st	Sesotho
sn	Shona	sd	Sindhi	si	Sinhala
sk	Slovak	sl	Slovenian	so	Somali
es	Spanish	su	Sundanese	sw	Swahili
sv	Swedish	tl	Tagalog (Filipino)	tg	Tajik
ta	Tamil	tt	Tatar	te	Telugu
th	Thai	tr	Turkish	tk	Turkmen
uk	Ukrainian	ur	Urdu	ug	Uyghur
uz	Uzbek	vi	Vietnamese	cy	Welsh
xh	Xhosa	yi	Yiddish	yo	Yoruba
zu	Zulu

version'last_published_version' | 'last_saved_version' | 'last_saved'

Which version of the guide to export. Defaults to 'last_published_version'.

purpose'EXPORT' | 'BPA'

Controls which set of step modules to include in the export. 'EXPORT' returns the standard set. 'BPA' additionally includes INPUT and CONTACT_FORM modules. Defaults to 'EXPORT'.

Response

Success

idinteger required

titlestring required

isFirstStepboolean required

contentstring required

The meaning of this field depends on the value of the 'type' field. For embedded guides (type='embeddedContent'), this contains the guideId string.

Step type

tagsstring[] required

Array of tag names for this step in the requested language (or guide's default language as fallback)

Example response

[
  {
    "id": 10,
    "title": "Welcome",
    "isFirstStep": true,
    "content": "Step content or metadata depending on type",
    "type": "regular",
    "nextSteps": [
      {
        "choiceLabel": "Continue",
        "id": 123
      }
    ],
    "tags": [
      "Product",
      "Feature"
    ]
  }
]

Changes

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