FansquareAPI reference
Open the app

Publications

List publications

GET/v1/publications

Lists the scheduled/published content of the agency (posts and stories), most recent first. Filterable by creator, type and status.

Required scoperead:publications
Rate limit30 requests per minute
curl 'https://api.fansquare.so/v1/publications' \
  -H "Authorization: Bearer $API_KEY" \
  -H "Fansquare-Version: Amethyste"
{
  "data": [
    {
      "id": "6136681c-548b-4fca-a86b-8f73b2926652",
      "creator_id": "m81IhLxdhzDGYs54rNp2",
      "type": "post",
      "status": "scheduled",
      "scheduled_at": "2026-10-14T19:00:00.000Z",
      "published_at": null,
      "media_uuid": "b12eacb2-afea-4959-a0d0-b685e6b49279",
      "caption": "New set tonight",
      "is_public": false,
      "audiences": [],
      "playlists": [
        "dc858a1c-bfca-4ab8-a445-cc2d76e1b784"
      ],
      "auto_action": "none",
      "auto_action_seconds": null,
      "failure_reason": null,
      "created_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.

  • typesstring

    Restrict to these types. Values: post, story. Comma-separated, 50 max.

  • statusesstring

    Restrict to these statuses. Values: draft, scheduled, published, failed, cancelled. Comma-separated, 50 max.

  • cursorstring

    Opaque cursor from the previous page (next_cursor).

  • limitinteger

    Page size (1-200).

    Default 50min 1max 200

Response

OK, application/json

  • dataarray of objectsrequired
    • idstringrequired

      Fansquare publication id. Path parameter of the /v1/publications/{publication_id} routes.

    • creator_idstringrequired

      Fansquare creator id (see GET /v1/creators).

    • typestringrequired

      A feed post or a story.

      Valuespoststory
    • statusstringrequired

      draft (no date yet), scheduled, published, failed (see failure_reason) or cancelled.

      Valuesscheduledpublisheddraftfailedcancelled
    • scheduled_atstringrequired

      When the publication is scheduled (ISO 8601). A draft carries a placeholder value.

      format date-time
    • published_atstring | nullrequired

      When it was actually published (ISO 8601), or null.

      format date-time
    • media_uuidstring | nullrequired

      MYM media uuid attached to the publication. null for a draft without media yet.

    • captionstring | nullrequired

      Post caption. null for stories.

    • is_publicboolean | nullrequired

      Post visibility. null for stories.

    • audiencesarray of stringsrequired

      Story audiences. Empty for posts.

      Valuessubscribersinterestedex_subscriberseveryone
    • playlistsarray of stringsrequired

      MYM playlist uuids the post is added to. Empty for stories.

    • auto_actionstringrequired

      Automatic action after publishing: none, delete (remove it) or pass_private (make it private).

      Valuesnonedeletepass_private
    • auto_action_secondsinteger | nullrequired

      Delay in seconds between publishing and the automatic action, or null without one.

    • failure_reasonstring | nullrequired

      Why publishing failed, when status is failed; null otherwise.

    • created_atstringrequired

      When the publication was created (ISO 8601).

      format date-time
  • next_cursorstring | nullrequired
curl 'https://api.fansquare.so/v1/publications' \
  -H "Authorization: Bearer $API_KEY" \
  -H "Fansquare-Version: Amethyste"
{
  "data": [
    {
      "id": "6136681c-548b-4fca-a86b-8f73b2926652",
      "creator_id": "m81IhLxdhzDGYs54rNp2",
      "type": "post",
      "status": "scheduled",
      "scheduled_at": "2026-10-14T19:00:00.000Z",
      "published_at": null,
      "media_uuid": "b12eacb2-afea-4959-a0d0-b685e6b49279",
      "caption": "New set tonight",
      "is_public": false,
      "audiences": [],
      "playlists": [
        "dc858a1c-bfca-4ab8-a445-cc2d76e1b784"
      ],
      "auto_action": "none",
      "auto_action_seconds": null,
      "failure_reason": null,
      "created_at": "2026-10-12T21:14:00.000Z"
    }
  ],
  "next_cursor": "KI7cfD0OLcWfeXZb1FTusJpz0nfKiYXPwHCZe-VXBaeQSX1w5BvO5UH-ua-dzNpXOTixzw"
}