Scripts

List script collections

GET/v1/script-collections

Lists the script collections of the agency, oldest first. A collection is a folder of scripts of one creator, the library the chatters pick from. Sort by position for the order of the app.

Required scoperead:scripts

Rate limit30 requests per minute

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

{
  "data": [
    {
      "id": "40a6e358-bd2a-4cff-a59e-5709874d3f5b",
      "creator_id": "m81IhLxdhzDGYs54rNp2",
      "name": "Lena",
      "description": "string",
      "position": 1,
      "script_count": 12,
      "created_at": "2026-10-12T21:14:00.000Z",
      "updated_at": "2026-10-12T21:14:00.000Z"
    }
  ],
  "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.
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 collection id. Path parameter of the /v1/script-collections/{collection_id} routes.
creator_idstringrequired
Fansquare creator id (see GET /v1/creators).
namestringrequired
Name of the collection, as shown in the Scripts page of the app.
descriptionstringrequired
Description of the collection. Empty when there is none.
positionintegerrequired
Order of the collection among those of its creator (0 first), as the app shows them.
script_countintegerrequired
Number of scripts in the collection.
created_atstringrequired
When the collection was created (ISO 8601).
format date-time
updated_atstringrequired
When the collection was last changed (ISO 8601).
format date-time
next_cursorstring | nullrequired

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

{
  "data": [
    {
      "id": "40a6e358-bd2a-4cff-a59e-5709874d3f5b",
      "creator_id": "m81IhLxdhzDGYs54rNp2",
      "name": "Lena",
      "description": "string",
      "position": 1,
      "script_count": 12,
      "created_at": "2026-10-12T21:14:00.000Z",
      "updated_at": "2026-10-12T21:14:00.000Z"
    }
  ],
  "next_cursor": "KI7cfD0OLcWfeXZb1FTusJpz0nfKiYXPwHCZe-VXBaeQSX1w5BvO5UH-ua-dzNpXOTixzw"
}