PostBoost TypeScript / Node.js SDK

Official TypeScript/Node.js client for the PostBoost API.

Install

npm install postboost

| | | |---|---| | npm | npmjs.com/package/postboost | | GitHub | postboost-co/postboost-node | | Docs | postboost.co/docs/api | | Version | v1.7.0 |

Quick start

import { PostsApi, Configuration } from 'postboost';

const api = new PostsApi(new Configuration({ accessToken: process.env.POSTBOOST_API_TOKEN }));

const posts = await api.listPosts('YOUR_WORKSPACE_UUID');
posts.forEach(post => console.log(post.uuid));

API Endpoints

All API endpoints are available as methods on the API classes:

| Class | Method | HTTP request | |-------|--------|-------------| | AccountsApi | listAccounts | GET /{workspaceUuid}/accounts | | AccountsApi | getAccount | GET /{workspaceUuid}/accounts/{accountUuid} | | MediaApi | listMedia | GET /{workspaceUuid}/media | | MediaApi | uploadMedia | POST /{workspaceUuid}/media | | MediaApi | getMedia | GET /{workspaceUuid}/media/{mediaUuid} | | MediaApi | updateMedia | PUT /{workspaceUuid}/media/{mediaUuid} | | MediaApi | deleteMedia | DELETE /{workspaceUuid}/media/{mediaUuid} | | TagsApi | listTags | GET /{workspaceUuid}/tags | | TagsApi | createTag | POST /{workspaceUuid}/tags | | TagsApi | getTag | GET /{workspaceUuid}/tags/{tagUuid} | | TagsApi | updateTag | PUT /{workspaceUuid}/tags/{tagUuid} | | TagsApi | deleteTag | DELETE /{workspaceUuid}/tags/{tagUuid} | | PostsApi | listPosts | GET /{workspaceUuid}/posts | | PostsApi | createPost | POST /{workspaceUuid}/posts | | PostsApi | getPost | GET /{workspaceUuid}/posts/{postUuid} | | PostsApi | updatePost | PUT /{workspaceUuid}/posts/{postUuid} | | PostsApi | deletePost | DELETE /{workspaceUuid}/posts/{postUuid} | | PostsApi | schedulePost | POST /{workspaceUuid}/posts/schedule/{postUuid} | | WorkspacesApi | listWorkspaces | GET /panel/workspaces | | WorkspacesApi | createWorkspace | POST /panel/workspaces | | UsersApi | listUsers | GET /panel/users | | UsersApi | createUser | POST /panel/users |

See the full API reference for all endpoints with parameters and response schemas.

License

MIT