FansquareAPI reference
Open the app

Get started

Fansquare API

Read and drive your agency data from your own tools, and receive signed webhooks when something happens.

The Fansquare API gives your own tools access to the data of your agency: creators, employees, orders and revenue, sent messages, fans and their CRM state (assignment, AI lock, notes, tags), publications. Webhooks push events to your servers as they happen.

It is made for server-to-server integrations: BI pipelines, spreadsheets fed by a script, internal dashboards, bots. Requests from a browser are not supported (CORS is disabled), so your API key never ends up in front-end code.

Base URL

Every endpoint lives under one host, over HTTPS only.

https://api.fansquare.so/v1

Quickstart

  1. 1

    Create an API key

    In the Fansquare app, open Settings › Developer API › API and select Generate key. Name the key, choose its access and the creators it covers. The key is shown once: store it in your secret manager right away.

  2. 2

    Make your first request

    GET /v1/me describes the key you are using. Every request carries the key and the API version you build against.

    Terminal
    curl https://api.fansquare.so/v1/me \
  -H "Authorization: Bearer $API_KEY" \
  -H "Fansquare-Version: Amethyste"
  3. 3

    Read your data

    List your creators, then the orders of the last days. Lists are paginated with a cursor.

    Terminal
    curl "https://api.fansquare.so/v1/orders?start=2026-10-01T00:00:00Z&limit=50" \
  -H "Authorization: Bearer $API_KEY" \
  -H "Fansquare-Version: Amethyste"

What you can build

Revenue in your BI

Daily revenue per creator and type of sale, ready for a chart, without downloading every order.

Orders ledger

Every sale converted to EUR, with the employee it is credited to.

Assign fans from your tools

Route a fan to an employee from your own routing logic.

AI locks for your bots

Tell Fansquare that your AI is handling a conversation, and release it.

Schedule publications

Create posts and stories, Fansquare publishes them on MYM.

Webhooks

Receive a signed request when a sale happens or a fan is reassigned.

Conventions

  • JSON everywhere, field names in snake_case. A request body is sent with Content-Type: application/json and weighs 256 KB at most.

  • Dates are ISO 8601 strings in UTC (2026-10-12T21:14:00.000Z).

  • Amounts are integers in cents, in the currency given next to them (always EUR today).

  • An endpoint that takes query parameters rejects the ones it does not know with a 400, so a typo never returns unfiltered data. Endpoints without query parameters ignore them. See Pagination and filters.

  • Every response carries an x-request-id header. Quote it when you contact support.

  • New fields can appear in any response without a new version: ignore the fields you do not know. See Versioning.