Overview
Glossary
Every Onepostly term with the field or endpoint where you meet it.
A linked term opens the page that explains it. The Where you meet it column names the field, id prefix or endpoint that carries the term.
Workspace and Accounts
| Term | Meaning | Where you meet it |
|---|---|---|
| Workspace | Your organization in Onepostly. It owns the accounts, keys, webhooks and billing | organizationId in webhook events |
| API key | The secret your server sends with every request. It belongs to one workspace | Authorization: Bearer op_... |
| Permission | What an API key may do, read_write or read_only | 403 FORBIDDEN on a read_only write |
| Account | One connected social account, such as an X account or a Facebook Page | acc_ ids, accountId |
| Profile | A named group of accounts that you connect into and filter by | profile, GET /v1/profiles |
| Account metadata | Your own key-value pairs on an account, such as the id of your user who connected it | metadata |
| Default profile | The profile every workspace starts with. Connects without a profile go there | profile: "Default" |
| Connect session | A short-lived sign-in link that connects an account from your own app | POST /v1/connect-sessions |
| Redirect URL | The page in your app the browser returns to after a connect or reconnect | redirectUrl |
| Headless connect | A connect session where you show the Page or account picker yourself | headless: true |
| Candidate | A Page or Instagram account the user can pick in a headless connect | candidateId |
| Login method | How an Instagram account signs in, directly or through a Facebook Page | loginMethod |
| App Password | A Bluesky password made for one app, used instead of a sign-in screen | appPassword |
| Account status | Whether an account can publish | status on an account |
| Auto-renew | Whether an account's access renews without the user signing in again | canAutoRenew, tokenExpiresAt |
| Reconnect | Renewing the access of an account you have. It keeps its id and profile | POST /v1/accounts/{id}/reconnect |
| Disconnect | Removing an account from the workspace | DELETE /v1/accounts/{id} |
| Account settings | Publishing defaults stored on an account, such as Bluesky post languages | /v1/accounts/{id}/settings |
| Account stats | Live audience counts, such as followers | GET /v1/accounts/{id}/stats |
| X subscription | The X plan of an X account, which sets its text limit | xSubscriptionType |
Posts and Media
| Term | Meaning | Where you meet it |
|---|---|---|
| Post | One post on one account, with its own status, link and metrics | pst_ ids, GET /v1/posts |
| Group | The posts one create request made, one per account | groupId, grp_ ids |
| Post status | Where a post is in its life, such as scheduled or published | status on a post |
| Post error | Why a post failed | error.code on a failed post |
| Platform post id | The platform's own id for a published post | platformPostId |
| Post URL | The public link to the post on the platform, once it has one | url |
| Per-account text | A text for one account instead of the shared text | accounts[].text |
| Platform options | Settings for one platform, such as a TikTok privacy level | accounts[].tiktok, options |
| Media kind | What a post publishes, such as multi_image, reel or stories | mediaKind |
| Media | A file you upload for your posts | med_ ids, media[].id |
| Media URL | A public HTTPS file URL you pass instead of an upload | media[].url |
| Upload URL | The address you PUT the file to after creating a media item | uploadUrl |
| Thread | Posts published as replies under the first one, on X, Threads and Bluesky | thread |
| Quote | A post that embeds another post | quotePostId |
| Reply post | A post published as a reply to another post, on Threads and Bluesky | replyToPostId |
| Scheduled post | A post that publishes at a set local time | scheduledFor, timezone |
| External post | A post the account published outside Onepostly, found by a sync | source: "external" |
| Metrics | A post's lifetime numbers, such as views and likes | GET /v1/posts/{id}/analytics |
| Analytics status | Whether metrics are ready for a post, such as ready or pending | status in post analytics |
| Timeline | A post's metrics day by day | /v1/posts/{id}/analytics/timeline |
| Account analytics | Account-level insights over a period, with demographic breakdowns | GET /v1/accounts/{id}/analytics |
Engagement and Inbox
| Term | Meaning | Where you meet it |
|---|---|---|
| Comment | A comment or reply on a post | cmt_ ids, /v1/posts/{id}/comments |
| Reply | Your answer to a comment | POST /v1/comments/{id}/replies |
| Hidden comment | A comment hidden from the public on the platform, without deleting it | /v1/comments/{id}/hidden |
| Private reply | A direct message sent in answer to a public comment | /v1/comments/{id}/private-reply |
| Like, repost, bookmark | Engagement your account does on a post | /v1/accounts/{id}/likes/{postId} |
| Reposters | The accounts that reposted a post | GET /v1/posts/{id}/reposts |
| Conversation | A direct message thread between an account and one person | cnv_ ids |
| Message | One direct message in a conversation | message.received |
| Messenger profile | The conversation starters and menu a Facebook Page shows in Messenger | /v1/accounts/{id}/messenger-profile |
| Review | A recommendation left on a Facebook Page | review.received |
| Automation | A rule that sends a direct message when a comment or message matches keywords | aut_ ids |
Webhooks and Events
| Term | Meaning | Where you meet it |
|---|---|---|
| Webhook | An HTTPS endpoint of yours that receives events | whk_ ids |
| Event | Something that happened, such as a published post or a new comment | type, evt_ ids |
| Event object | The object the event is about, as it was when the event happened | data.object |
| Wildcard | A subscription to every event type, including ones added later | events: ["*"] |
| Delivery | One event sent to one webhook, with its attempts | dlv_ ids |
| Signing secret | The secret that signs each delivery, so you can verify it came from Onepostly | secret on a new webhook |
| Test event | A sample event you send to check your endpoint | webhook.test |
API Basics
| Term | Meaning | Where you meet it |
|---|---|---|
| Base URL | The address of every API request | https://api.onepostly.com |
| Id prefix | The start of an id that names its kind, such as acc_ or pst_ | Every id |
| Cursor | The position of the next page in a list | cursor, nextCursor, hasMore |
| Include | Extras you ask a list to add | include=total, include=facets |
| Time filters | Limits a list to a time window | since, until |
| Idempotency key | A unique key that makes a retried request safe | Idempotency-Key header |
| Error code | The stable reason of an error. Build your logic on it | code in the error body |
| Request id | The id of one request, for support | Request-Id, requestId |
| Open enum | A list of values that can grow, such as status. Handle values you do not know | "New values can be added" |
| Rate limit | How many requests the workspace can send in a window | X-RateLimit-*, Retry-After |
| Wallet | The prepaid balance that pays for X actions | GET /v1/wallet |
| Billing block | The state of a workspace that must fix billing before it can use the API | 402 PAYMENT_METHOD_REQUIRED |
| MCP server | The server that lets AI clients such as Claude use Onepostly as tools | https://mcp.onepostly.com |