PostRSS REST API v1: Create Targets and Read Reports

Short answer: The PostRSS REST API v1 lets you sign in, list your connected accounts, create and update targets with their RSS or CSV sources, read the processing report of every target and see your plan usage, all with JSON over HTTPS. You sign in once with your e-mail and password to receive a bearer token, send that token in the Authorization header of every request and use the documented endpoints under /api/v1. The interactive documentation shows every field, and a target created through the API appears in the web app exactly like one created by hand.

Most people set up PostRSS in the web app: paste a feed address, connect an account and choose how each post is built. That is the fastest way to start, and it needs no code. Some teams want more. An agency may create dozens of targets for new client sites. A developer may want to show posting results inside an internal dashboard. A publisher may want to check, every morning, whether any source failed overnight. For these cases PostRSS offers a REST API, version 1, with JSON requests and responses and bearer authentication. This guide walks through the parts that matter in daily use: signing in, understanding the shape of a target, creating one, changing it safely, reading reports and checking your usage. Every field name below comes from the live API documentation, which you can open at any time.

What the API is for

The API covers the same ground as the web app, which is why it is useful for automation. In practice there are five groups of tasks:

• Account and sign-in. Sign in with e-mail and password, or with a Google, Facebook or Apple login, and manage the devices that hold tokens.
• Connected accounts. List the social accounts already connected and start the connection of new ones for the networks that support it.
• Targets. Create, read, update and delete the targets that publish to a page, channel, board or blog, each with one or more sources.
• Reports and statistics. Read the processing history of a target, the items seen in one run and the number of posts by network.
• Plan and team. Read the current plan, the limits and the usage, and manage team members if your plan includes them.

The documentation states that times are in ISO 8601 format with an offset and that team members receive the owner’s data with the same restrictions as on the website. Some actions, such as disconnecting an account or inviting a team member, are limited to the owner.

Open the interactive documentation

The reference lives at app.postrss.com/api/v1/docs and is built with Swagger UI, so every endpoint can be read, tried and copied. Use it as the source of truth for field names and allowed values, and use this article as a map. If you prefer a machine-readable file, the same description is available as an OpenAPI document, which tools can turn into a client for your language. Keep the documentation open next to your editor while you work, because several fields accept only a fixed list of values.

Sign in and get a token

Send your e-mail, your password and an optional device name to the sign-in endpoint. The device name appears in your list of devices, so use something recognizable, such as the name of the script or server.

curl -s -X POST https://app.postrss.com/api/v1/auth/login -H "Content-Type: application/json" -d '{"email":"[email protected]","password":"your-password","device_name":"nightly-report-script"}'

The response contains the token, its type, an expiry time if one applies and your user profile. The token is shown only once, so store it in a secret manager or an environment variable and never in a repository. Every later request carries it in the header Authorization: Bearer YOUR_TOKEN. You can list all tokens with the devices endpoint and revoke one if a script is retired or a laptop is lost, and a logout request revokes the current token. Treat a token like a password: give each script its own sign-in so that you can revoke one without affecting the rest.

Understand the shape of a target

A target is a place where posts are published, such as a Facebook Page, a Telegram channel or a Bluesky account. In the API it is returned together with its sources, which are the feeds or files that supply the items. A feed object has a name, a target reference and a list of sources. The target reference holds the network type, whether it is active and the account to publish to. A source has a type, either rss sau csv, and the settings that control how and when its items are posted.

The frequency must be at least the minimum allowed by your plan, so read the plan before you choose a value. The full list of source keys is in the documentation.

List your accounts and targets

Before you create a target you need to know which accounts can be used. The accounts endpoint lists the connected accounts, and there are helper endpoints per network, for example the one that returns the Facebook Pages you can publish to or the Telegram channels you have connected. A request to list targets returns every target with its sources, which is a convenient way to back up your configuration or to audit it.

curl -s https://app.postrss.com/api/v1/targets -H "Authorization: Bearer YOUR_TOKEN"

Read this list once and keep an example of a working target, because the easiest way to create a new target is to copy the structure of an existing one.

Create a target with an RSS source

Creating a target is a POST request with the full feed object: a name, the target reference and at least one source. A minimal example for a feed that should be checked every hour and posted newest first looks like this. Replace the placeholders with values from your own account.

{
  "name": "Company blog to Telegram",
  "target": { "type": "telegram_channel", "active": 1, "title": "Company news" },
  "sources": [
    {
      "type": "rss",
      "name": "Blog feed",
      "link": "https://example.com/feed/",
      "active": 1,
      "message_format": "same_as_item_title",
      "processing_type": "frequency",
      "frequency": 3600,
      "publishing_order": "newer_first",
      "maximum_posts_per_update": 3,
      "additional_query_parameters": "utm_source=postrss&utm_medium=social"
    }
  ]
}

Treat the example as a shape and check the exact required keys of the target reference in the documentation, because they depend on the network. The response returns the created target with its identifiers. Open the web app to see it in your list: it behaves exactly like a target created by hand, so you can mix both ways of working.

Use a CSV file as a source

If you have no feed, a CSV file can supply the items, where each row becomes one post. CSV sources are available on the Professional plan and above. The API has a dedicated upload endpoint that accepts a multipart form with a file, and the returned file name is then referenced by a source of type csv. This is handy for campaigns prepared in a spreadsheet: generate the file, upload it, create the target and let PostRSS publish the rows.

Update a target safely

The update request is a PUT, and the documentation asks you to send the full object. The reliable routine has three steps: read the target with a GET request, change only the fields you need in your copy, and send the whole object back. Keys that you leave out of some groups, such as the filter and hashtag settings, keep their saved values, but the safest habit is still to start from what the server returned. Never build an update from memory, because a missing source could be treated as removed. Delete requests are permanent, so log the identifier and the name of what you remove.

Read the report of a target

Each time PostRSS checks a source it records a run. The report endpoint returns the runs of a target with the source, the date, whether the run succeeded, a failure reason when there is one, the number of items seen and the number of posts made. It accepts a limit, an offset and a flag that returns only runs that posted something or failed, which is the best starting point for a morning check. For one run you can request the items it saw. Each item has a link, a message, an image link and a status such as processed, failed, skipped, already posted, filtered or blocked because the maximum number of posts per update was reached. Items removed by a keyword filter are shown as filtered and are not counted against your quota.

curl -s "https://app.postrss.com/api/v1/targets/123/report?only_posted=1&limit=20" -H "Authorization: Bearer YOUR_TOKEN"

A small script that lists failed runs every morning and sends the result to your team chat is often the first automation that people build.

Check statistics and plan usage

The statistics endpoint returns the number of posts for a period, split by network type, with a monthly history. The subscription endpoint returns your plan, the dates, the number of posts used this month and your limit, the number of targets used and the target limit, and a link to the page for upgrades. Compare usage with the limits before you create many targets at once, and remember that the available networks depend on the plan. The plans endpoint is public and lists every plan with its limits and supported networks, which is the right source for any table of plans you show to your own customers. See the pricing page for the current plans.

Manage team members

The team endpoints let an owner see how many additional users the plan allows, how many are used and who they are, and invite or remove a member. Additional users are part of Enterprise plans. Team members see the owner’s data with the same restrictions as on the website, so give each person their own invitation and remove them when they leave.

Good habits for API users

• One token per script. Revoke a single device without disturbing others.
• Secrets outside the code. Keep tokens in environment variables or a secret store.
• Read before write. Start every update from the current object.
• Start small. Create one target, check it in the web app, then repeat in bulk.
• Handle errors. Error responses are JSON with a code and a message, so log them.
• Respect the plan. Check limits before bulk changes.

When to use the API and when the web app is enough

For one site and a few networks the web app is quicker, and you can read about the options on the PostRSS features page. The API earns its place when the same action must be repeated many times, when another system should trigger a change or when you want results in your own tools. Many users combine both: they create the first target by hand, copy its structure into a script and let the script handle the rest. If you only need to send each new item to another system, the guide to webhooks for Zapier, n8n and Make may be simpler.

Lecturi conexe

• Autopostare pe Zapier, n8n și Make
• RSS keyword filters: include and exclude
• Post text format per network

The bottom line

The PostRSS REST API v1 gives you the same control as the web app in a form that scripts can use. Sign in once, store the token safely, read an existing target to learn its shape, create new targets with their sources, update with the full object, check the report of every run and watch your usage against the plan. Use the interactive documentation as the reference for every field, start with one target and automate the rest.

FAQ

How do I authenticate with the PostRSS API?

Send your e-mail and password to the sign-in endpoint to receive a bearer token, then send it in the Authorization header of every request. The token is shown once, so store it safely.

Can I create a target through the API?

Yes. A POST request with a name, a target reference and at least one source creates it, and it then appears in the web app like any other target.

How do I change an existing target?

Read it with a GET request, edit the fields you need and send the whole object back with a PUT request. Do not build the update from memory.

Can I read what PostRSS posted?

Yes. The report endpoint lists the runs of a target, and a second endpoint lists the items seen in a run with a status for each item.

Do I need the API to use PostRSS?

No. You can set everything up in the web app without code. The API is for automation, bulk changes and your own dashboards.