Sometimes you want to control your community settings, user data or other information programmatically, especially when integrating PeerBoard with other products or your own custom logic. Our API provides you with a collection of REST endpoints to extend capabilities provided by our UI and enable some important programmatic logic.
💡 We also have a separate community creation API for our partner platforms to include in their self-serve process, read more.
To call any of our general APIs you need to pass your community auth token in authentication header. You can find this token in community Settings -> Hosting.
Full list of our API endpoints with parameter and result schemas can be found here: https://api.peerboard.com/docs/#overview - the list is evolving so please let us know if there's a piece missing in the comments.
We recommend calling our APIs for those specific cases:
- Automatically register your existing users via our user creation API. This will send them a welcome email and subscribe to your board daily digests even if they haven't opened the community yet.
- Call user update endpoint when a user changes personal information on your side, such as name, profile picture or email. As mentioned above, this is important even if you use your profiles since we still have profile previews. This is also critical for any email changes so we have the latest email.
- Call user update endpoint when a user deletes or deactivates an account on your side, passing "banned" as a user role. This would disable email digests and any other email notifications from the community. Otherwise this user will keep receiving potentially private information.
For more information please check our API questions section and please ask us if you haven't found an answer in existing threads.
If your problem is urgent, please email us directly at email@example.com