Skip to main content

Core Concepts

Data Model​

PostBoost is multi-tenant. Every resource lives inside a Workspace.

User
 └── Workspace (many-to-many via role)
      ├── Account  (connected social profile: Twitter, Instagram, …)
      ├── Post     (scheduled or published content)
      ├── Media    (uploaded images / videos)
      └── Tag      (color-coded labels for posts)

User​

A person with login credentials. A user can belong to multiple workspaces with different roles (Owner, Admin, Member).

Workspace​

The top-level container for all your social media activity. Every API call that touches posts, accounts, media, or tags requires a workspaceUuid. Get yours from the dashboard URL or via GET /panel/workspaces (admin) or GET /workspaces.

Account​

A connected social media profile — for example, a Twitter account or an Instagram business profile. Accounts belong to a Workspace. When creating a post you specify which Account IDs to publish to.

Post​

A piece of content to be published. Posts have one or more versions — one version per target Account — letting you customize copy per platform. One version must be marked is_original: true.

Media​

Uploaded image or video files that can be attached to post versions. See Media Uploads for upload flows.

API Tiers​

PostBoost has two distinct groups of endpoints:

Workspace-scoped endpoints​

GET  /{workspaceUuid}/accounts
GET  /{workspaceUuid}/posts
POST /{workspaceUuid}/posts
GET  /{workspaceUuid}/media
GET  /{workspaceUuid}/tags

Used for day-to-day operations within a single workspace. Any valid API token with access to that workspace can call these. Most integrations only ever use these endpoints.

Admin (panel) endpoints​

GET  /panel/workspaces
GET  /panel/users
GET  /panel/subscriptions
GET  /panel/receipts

Used for platform administration — managing workspaces, users, billing, and subscriptions. Requires an admin-role token. Non-admin tokens receive 403 Forbidden.

info

If you only need to publish posts and manage social accounts, you will never need /panel/* endpoints.

Finding Your Workspace UUID​

curl https://postboost.co/app/api/workspaces \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Response:

{
  "data": [
    { "uuid": "ws-abc123", "name": "Acme Co" }
  ]
}

Use ws-abc123 as {workspaceUuid} in all subsequent workspace-scoped requests.

Next steps​