We are listing the available API endpoints for habitate.io. These can be used to build additional feature and create linked services around your community.

In case you need more help you can get in touch with the team, developer-support at habitate.io

Create a Board

Endpoint

POST /api/v1/boards

Body parameters

Name	Type	Req?	Comments
board_name	string	Y
about	string	N	The details/description of the board
is_private	boolean	Y	Private boards are restricted to users who are part of the board
hidden_type	integer	Y	Should the board be visible to guests?
permission_for	integer	Y	Who can post in this board?
needs_approval	boolean	Y	Does user need approval to post in board?
icon	String	N	The board icon displayed in the ui.

Options for ‘hidden_type’

Possible values	Comments
0	Visible to all users.
1	Visible to any members who is logged in.
2	Not visible unless user is part of the board.

Options for ‘permission_for’

Possible values	Comments
1	Only admins can post
5	Admins and moderators can post.
10	Any member of the community can post in the board.

Note: ‘permission_for’ parameter will change soon so that you can pass a list of role ids.

Response parameters

{
  "board_id": 0,
  "display_order": 0,
  "board_name": "string",
  "board_type": "string",
  "is_private": true,
  "hidden_type": 0,
  "permission_for": 0,
  "needs_approval": true,
  "pinned_posts": [
    0
  ],
  "post_count": 0,
  "last_posted_at": "2022-02-22T22:22:22.222Z",
  "icon": "string",
  "about": "string"
}