Basisadresse
Senden Sie jede Anfrage an diese Adresse. Ein selbst gehostetes PostNimbo nutzt stattdessen seine eigene Backend-Adresse.
https://postnimbo.com/api/public/v1
Authentifizierung
Setzen Sie die Zugangsdaten unverändert in den Authorization-Header, ohne Bearer-Präfix. Zwei Arten funktionieren:
- Ein API-Schlüssel aus Einstellungen > Agenten / Dev. Er handelt als gesamter Workspace und erreicht jede Route unten.
- Ein OAuth-Zugriffstoken (beginnt mit pos_) aus einer OAuth-App. Es handelt als das Mitglied, das es genehmigt hat, sieht nur dessen Marken und Kanäle und ist auf die genehmigten Scopes beschränkt.
curl https://postnimbo.com/api/public/v1/me \ -H "Authorization: <api key or pos_ token>"
Fehlende oder falsche Zugangsdaten ergeben 401. Eine Route, für die ein Token nicht genehmigt wurde, ergibt 403. Fehler enthalten ein Feld msg oder message.
Rate Limits
- 120 Anfragen pro Minute für jeden API-Schlüssel oder jedes Token, über alle Routen.
- Das Erstellen von Beiträgen ist zusätzlich pro Workspace und Stunde begrenzt (standardmäßig 90).
- Bei Überschreitung lautet die Antwort 429 mit einem Retry-After-Header in Sekunden. Warten Sie so lange, bevor Sie es erneut versuchen.
Selbst gehostete Server legen ihre eigenen Limits mit PUBLIC_API_RATE_LIMIT, PUBLIC_API_RATE_TTL und API_LIMIT fest.
Endpunkte
Die Spalte Scope zeigt, was ein OAuth-Token braucht. Ein API-Schlüssel erreicht jede Route.
Account
- GET
/public/v1/meThe workspace the credential belongs to, and for an OAuth token the member who approved it.
ScopeJedes Token - GET
/public/v1/is-connectedCheck that the credential works.
ScopeJedes Token - GET
/public/v1/groupsThe brands (customers) the credential can see.
ScopeJedes Token - GET
/public/v1/countsPosts waiting for approval and unread open inbox conversations.
Scopeposts:readinbox:readEingabequery: brandId?
Channels
- GET
/public/v1/integrationsThe connected channels, with their ids and networks.
Scopeposts:readEingabequery: group? (a brand id) - GET
/public/v1/integration-settings/:idThe rules of a channel: character limits, media rules and the settings a post needs.
ScopeAPI-Schlüssel oder Token mit Vollzugriff - GET
/public/v1/find-slot/:idThe next free posting slot of a channel.
Scopeposts:read - GET
/public/v1/social/:integrationThe sign-in link that connects a new channel of a network (for example linkedin).
ScopeAPI-Schlüssel oder Token mit VollzugriffEingabequery: refresh? (a channel id to reconnect) - DELETE
/public/v1/integrations/:idDisconnect a channel.
ScopeAPI-Schlüssel oder Token mit Vollzugriff - POST
/public/v1/integration-trigger/:idRun a lookup a network offers (for example the playlists of a YouTube channel).
ScopeAPI-Schlüssel oder Token mit VollzugriffEingabebody: { methodName, data }
Posts
- GET
/public/v1/postsThe posts between two dates.
Scopeposts:readEingabequery: startDate, endDate (ISO 8601), customer? - POST
/public/v1/postsCreate a draft, schedule a post or publish now, on one or more channels.
Scopeposts:scheduleEingabebody: { type: draft|schedule|now, date, shortLink, tags, posts: [{ integration: { id }, value: [{ content, image? }], settings? }] } - PUT
/public/v1/posts/:id/settingsChange the network settings of a post.
ScopeAPI-Schlüssel oder Token mit VollzugriffEingabebody: { settings } - PUT
/public/v1/posts/:id/statusMove a post between draft and scheduled.
ScopeAPI-Schlüssel oder Token mit VollzugriffEingabebody: { status: draft|schedule } - GET
/public/v1/posts/:id/missingFor a post the network accepted without returning its id: the recent posts of the channel to pick it from.
ScopeAPI-Schlüssel oder Token mit Vollzugriff - PUT
/public/v1/posts/:id/release-idLink a post to the network post it became.
ScopeAPI-Schlüssel oder Token mit VollzugriffEingabebody: { releaseId } - DELETE
/public/v1/posts/:idDelete a post.
ScopeAPI-Schlüssel oder Token mit Vollzugriff - DELETE
/public/v1/posts/group/:groupDelete every post of a group (one post sent to several channels).
ScopeAPI-Schlüssel oder Token mit Vollzugriff
Media
- POST
/public/v1/uploadUpload a file to the media library.
Scopemedia:writeEingabemultipart: file, adjust? - POST
/public/v1/upload-from-urlAdd a file from a public https address.
Scopemedia:writeEingabebody: { url, adjust? } - GET
/public/v1/mediaThe media library, a page at a time.
ScopeAPI-Schlüssel oder Token mit VollzugriffEingabequery: page?, search?, folder? - GET
/public/v1/media/:id/statusWhether an uploaded video finished processing.
ScopeAPI-Schlüssel oder Token mit Vollzugriff
Ideas
- POST
/public/v1/ideasSave an idea to the Ideas board.
Scopeideas:writeEingabebody: { title, content? } - DELETE
/public/v1/ideas/:idRemove an idea the credential saved.
Scopeideas:write
Analytics
- GET
/public/v1/performanceA summary of the last 7 days: posts, reach and engagement.
Scopeanalytics:readEingabequery: brandId?, tz? - GET
/public/v1/best-times/nextThe next best times to post, from your own results.
Scopeposts:readEingabequery: integrationId?, brandId?, tz?, goal?: engagement|reach|views, count? (1-20) - GET
/public/v1/analytics/:integrationThe analytics of a channel.
ScopeAPI-Schlüssel oder Token mit VollzugriffEingabequery: date (days back) - GET
/public/v1/analytics/post/:postIdThe analytics of one published post.
ScopeAPI-Schlüssel oder Token mit VollzugriffEingabequery: date (days back)
AI
- POST
/public/v1/ai/draftDraft a post about a web page with PostNimbo AI.
Scopeai:useEingabebody: { url, title?, selection?, mode: summary|captions } - POST
/public/v1/ai/replyDraft a reply to a comment or message.
Scopeai:useEingabebody: { text, url? }
Link in bio
- GET
/public/v1/link-in-bioThe link-in-bio pages of the workspace.
Scopelink-in-bio:write - POST
/public/v1/link-in-bio/:id/linksAdd a link to a link-in-bio page.
Scopelink-in-bio:writeEingabebody: { label, url }
Video and clipping
- POST
/public/v1/generate-videoGenerate a video with one of the AI video tools.
ScopeAPI-Schlüssel oder Token mit Vollzugriff - POST
/public/v1/video/functionLoad the options of a video tool (voices, avatars).
ScopeAPI-Schlüssel oder Token mit Vollzugriff - POST
/public/v1/clippingCut a long video into short clips.
ScopeAPI-Schlüssel oder Token mit Vollzugriff - GET
/public/v1/clippingThe clipping jobs, a page at a time.
ScopeAPI-Schlüssel oder Token mit VollzugriffEingabequery: page - GET
/public/v1/clipping/:idOne clipping job and its clips.
ScopeAPI-Schlüssel oder Token mit Vollzugriff
Notifications
- GET
/public/v1/notificationsThe workspace notifications, a page at a time.
ScopeAPI-Schlüssel oder Token mit VollzugriffEingabequery: page?
Webhooks
- GET
/public/v1/webhooks/eventsThe events a webhook is sent, with a sample payload of each.
ScopeJedes Token - GET
/public/v1/webhooksThe webhooks of the workspace, without their addresses; ?url= finds the webhooks of one address.
Scopewebhooks:writeEingabequery: url? - POST
/public/v1/webhooksSubscribe an address to events (how Zapier, Make and n8n triggers switch on).
Scopewebhooks:writeEingabebody: { url, events?, integrations? (channel ids), name? } - DELETE
/public/v1/webhooks/:idRemove a webhook (how a trigger switches off).
Scopewebhooks:write
