The public REST API
Base URL, your first call, the shape of requests and responses, and where the machine-readable spec is.
The basics
https://api.posty.hu/public/v1Authorization header, or an OAuth 2.1 access tokenThe first call
/status responds without a key (apart from the two /signuppaths that create an account, it is the only one). That's the fastest way to check you can reach us, and it gives you the URL of every other document:
curl https://api.posty.hu/public/v1/statusThe first authenticated call lists your channels:
curl https://api.posty.hu/public/v1/integrations \
-H "Authorization: psty_your_key"The API key is the Authorization header's entire value, with no Bearer. The Bearer prefix belongs to the OAuth token. That's the most common reason a first call gets a 401.
You create the key yourself in Postemi. See the Authentication page.
What v1 can do
The API manages the same workspace as the web interface. The one thing it cannot do is connect a channel, because the platform asks a person to do that.
You'll find the full list on the Endpoints page, with a separate page for each endpoint.
Request and response shape
Every body is JSON, and every date is ISO 8601 UTC. Errors are JSON too. The Errors and limits page describes their shape and the rate limits.
If a key belongs to more than one workspace, the showorg header selects which one the call applies to.
Machine-readable description
https://api.posty.hu/.well-known/oauth-protected-resourceYou can generate client code from the OpenAPI document, and every scope name is in it under components.securitySchemes.