Script sequences

List script sequences

GET/v1/script-sequences

Lists the script sequences of the agency, oldest first, without their steps (get_script_sequence for the tree). A sequence is the path of a conversation: ordered steps, each offering scripts to the chatter depending on what the fan did.

Required scoperead:scripts

Rate limit30 requests per minute

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

{
  "data": [
    {
      "id": "40a6e358-bd2a-4cff-a59e-5709874d3f5b",
      "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",
      "step_count": 12
    }
  ],
  "next_cursor": "KI7cfD0OLcWfeXZb1FTusJpz0nfKiYXPwHCZe-VXBaeQSX1w5BvO5UH-ua-dzNpXOTixzw"
}

Parameters

Headers

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

Query

creator_idsstring
Restrict to these creators (Fansquare ids from GET /v1/creators). Comma-separated, 50 max.
statusesstring
Restrict to these statuses. Values: draft, published. Comma-separated, 50 max.
cursorstring
Opaque cursor from the previous page (next_cursor).
limitinteger
Page size (1-100).
Default 50min 1max 100

Response

OK, application/json

dataarray of objectsrequired
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
step_countintegerrequired
Number of steps.
next_cursorstring | nullrequired

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

{
  "data": [
    {
      "id": "40a6e358-bd2a-4cff-a59e-5709874d3f5b",
      "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",
      "step_count": 12
    }
  ],
  "next_cursor": "KI7cfD0OLcWfeXZb1FTusJpz0nfKiYXPwHCZe-VXBaeQSX1w5BvO5UH-ua-dzNpXOTixzw"
}