Script sequences

Get a script sequence

GET/v1/script-sequences/{sequence_id}

Returns a sequence with its whole tree: steps in order, and for each step its options (condition, script). 404 if it does not exist in the agency.

Required scoperead:scripts

Rate limit60 requests per minute

curl 'https://api.fansquare.so/v1/script-sequences/e799e6a3-b43b-4466-a455-eb224a8f9bf1' \
  -H "Authorization: Bearer $API_KEY" \
  -H "Fansquare-Version: Amethyste"

{
  "id": "e799e6a3-b43b-4466-a455-eb224a8f9bf1",
  "creator_id": "m81IhLxdhzDGYs54rNp2",
  "name": "Lena",
  "status": "draft",
  "published_at": null,
  "created_at": "2026-10-12T21:14:00.000Z",
  "updated_at": "2026-10-12T21:14:00.000Z",
  "steps": [
    {
      "id": "05d8446f-24ff-403e-acc9-c66c59b9ca74",
      "title": "string",
      "context_note": "string",
      "options": [
        {
          "id": "59d4364a-a19e-4efb-a647-e8d32ade0d3c",
          "condition": "any",
          "label": "Orders to accounting",
          "delay_hours": 12,
          "context_note": "string",
          "script_id": "7668136a-d6ea-4b9d-a45d-f8b902de321f",
          "script_name": "string"
        }
      ]
    }
  ]
}

Parameters

Headers

Fansquare-Versionstringrequired
API version to pin. Accepts the mineral name or the release date of a version.

Path

sequence_idstringrequired
Fansquare script sequence id (the id field of sequence items).
format uuid

Response

OK, application/json

idstringrequired
Fansquare script sequence id. Path parameter of the /v1/script-sequences/{sequence_id} routes.
creator_idstringrequired
Fansquare creator id (see GET /v1/creators).
namestringrequired
Name of the sequence.
statusstringrequired
published (offered to chatters in the conversation) or draft (visible in the app editor only, until published).
Valuesdraftpublished
published_atstring | nullrequired
When the sequence was published (ISO 8601), null for a draft.
format date-time
created_atstringrequired
When the sequence was created (ISO 8601).
format date-time
updated_atstringrequired
When the sequence was last changed (ISO 8601).
format date-time
stepsarray of objectsrequired
The steps, in order: the conversation goes from one step to the next.
idstringrequired
Step id. Send it back in replace_script_sequence to keep the step (and the fans on it).
titlestringrequired
Title of the step, the stage of the conversation ("Premium content").
context_notestring | nullrequired
Note for the chatters about this step. Never sent to the fan.
optionsarray of objectsrequired
The scripts a chatter can send at this step, each with its condition.
idstringrequired
Option id. Send it back in replace_script_sequence to keep the option (and the fans on it).
conditionstringrequired
When the chatter is offered this option, judged on what the fan did since the message of the PREVIOUS step: any (always offered; the only one allowed on the first step), no_reply (the fan has not answered, after delay_hours if set), bought (the fan bought the media of the previous step), not_bought (the fan has not bought it, after delay_hours if set), other (a case of your own, described by label).
Valuesanyno_replyboughtnot_boughtother
labelstring | nullrequired
Description of the case, for the other condition. null otherwise.
delay_hoursinteger | nullrequired
Hours to wait before the option is offered, for no_reply and not_bought. null otherwise.
context_notestring | nullrequired
Note for the chatters about this option. Never sent to the fan.
script_idstring | nullrequired
The script sent with this option (see get_script). null when that script was deleted: replace the option.
script_namestring | nullrequired
Name of that script, null when it was deleted.

curl 'https://api.fansquare.so/v1/script-sequences/e799e6a3-b43b-4466-a455-eb224a8f9bf1' \
  -H "Authorization: Bearer $API_KEY" \
  -H "Fansquare-Version: Amethyste"

{
  "id": "e799e6a3-b43b-4466-a455-eb224a8f9bf1",
  "creator_id": "m81IhLxdhzDGYs54rNp2",
  "name": "Lena",
  "status": "draft",
  "published_at": null,
  "created_at": "2026-10-12T21:14:00.000Z",
  "updated_at": "2026-10-12T21:14:00.000Z",
  "steps": [
    {
      "id": "05d8446f-24ff-403e-acc9-c66c59b9ca74",
      "title": "string",
      "context_note": "string",
      "options": [
        {
          "id": "59d4364a-a19e-4efb-a647-e8d32ade0d3c",
          "condition": "any",
          "label": "Orders to accounting",
          "delay_hours": 12,
          "context_note": "string",
          "script_id": "7668136a-d6ea-4b9d-a45d-f8b902de321f",
          "script_name": "string"
        }
      ]
    }
  ]
}