API Overview

The FoPost REST API is what the dashboard itself runs on. Anything you can do in the app you can do from your own code: create posts, schedule them, attach media, read analytics, drive automations, and receive webhooks.

Base URL

https://api.fopost.com/v1

Every path in this reference is relative to that base. The machine-readable spec is served at /v1/openapi.json and is the source this reference is written from.

Authentication

Send your API key in the X-API-Key header:

curl https://api.fopost.com/v1/posts \
  -H "X-API-Key: $FOPOST_API_KEY"

Keys carry scopes, and a key may be bound to a single workspace. See Authentication.

Response envelope

A single resource is returned bare:

{
  "id": "0f1c4a1e-8f3c-4c62-9f6a-2a4b1a9e77d1",
  "workspace_id": "7d2b8c11-4e5a-4a8f-b0d9-3c5e6f7a8b90",
  "status": "scheduled"
}

A collection is wrapped in data with a meta block:

{
  "data": [ { "id": "0f1c4a1e-...", "status": "published" } ],
  "meta": { "page": 1, "per_page": 30, "total": 214, "total_pages": 8 }
}

Pagination

List endpoints take page (default 1) and per_page (default 30, maximum 100). Read meta.total_pages rather than paging until you get an empty array.

curl "https://api.fopost.com/v1/posts?page=2&per_page=50" \
  -H "X-API-Key: $FOPOST_API_KEY"

Identifiers and timestamps

Resource ids are UUIDs. Timestamps are ISO 8601 in UTC (2026-08-29T14:30:00.000Z), and any time you send is interpreted the same way, so convert local times before sending them.

Errors

Errors use one envelope on every endpoint:

{
  "error": "validation_error",
  "message": "accounts must contain at least one account id"
}

error is the stable machine-readable code, message is for humans and may change. Some errors add context fields, such as retry_after on a 429.

A 403 is also what you get for a workspace you do not belong to. The API never distinguishes "not yours" from "does not exist" in a way that would let you probe for other tenants' data.

Versioning

The version lives in the path. /v1 will not change shape under you: new fields and new endpoints are added, existing fields are not removed or repurposed. Treat unknown fields in a response as forward compatible and ignore them.

Where to go next