The TweetX API

Programmatic access to your posts, queue, and analytics. Mint an API key as an owner or editor and call the v1 endpoints.

Quick answer

TweetX has a v1 API for posts, the queue, and analytics. Mint an API key in your workspace, which requires an owner or editor role, then call the endpoints with that key. Keep the key secret and treat it like a password.

What the API covers

The v1 API lets you work with a workspace programmatically instead of through the app. It covers the core surfaces: your posts, your queue, and your analytics. Use it to pull your numbers into your own dashboards, push drafts from another tool, or automate parts of your posting flow.

  • Posts: work with your drafts and published posts.
  • Queue: add to and read the scheduling queue.
  • Analytics: pull the same real metrics the dashboard uses.

Minting an API key

  1. 1
    Check your role
    Minting a key requires an owner or editor role in the workspace.
  2. 2
    Create the key
    Generate an API key from your workspace settings.
  3. 3
    Copy and store it safely
    Save the key somewhere secure. Treat it like a password and never commit it to a repo.
  4. 4
    Send it with every request
    Pass the key with your API calls to authenticate as that workspace.
Keep your key secret
An API key acts on behalf of your workspace. Do not put it in client side code, URLs, or logs. If a key leaks, revoke it and mint a new one.

Rate limits and quotas

The API applies rate limits and daily quotas to keep usage fair. Build your integration to handle being throttled: back off and retry rather than hammering an endpoint. Design for occasional limit responses so a burst of calls does not break your flow.

Limits are evolving
Rate limiting is being hardened as the platform matures. Do not rely on exact thresholds staying fixed. Handle limit responses gracefully and you will be fine as the numbers settle.

Building a good integration

  • Store keys server side, never in a browser.
  • Retry with backoff instead of tight retry loops.
  • Cache analytics you read often instead of re-fetching constantly.
  • Rotate a key immediately if you think it leaked.

FAQ

Only owners and editors. Viewers cannot mint keys.