Introduction

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

---

Common Info

Below are some options that are applicable to all APIs endpoints unless mentioned otherwise.

Base Url

The base url will be your habitate url (e.g. community.habitate.io). If you have configured custom domain then you can also use the same as your base url.

Header Options

Key	Description
Content-Type	Use application/json
Authorization	If using basic auth then it will be similar to Basic <credentials>
User-Agent	Using a proper user agent string can help for audit/debugging purposes.

Any endpoints that provide a list of resources will have the paging options as mentioned below.

Paging Options

Query parameters	default	comments
page	1	page number, starts at 1
page_size	10	number of items returned per page(pp), max input value is 50. Note: This is the maximum number of items you can get in the response list. At times the response list size can be less than this limit. You will have to check the has_more http header if the there are more items to query.

Http Header Response	comments
has_more	possible values are “1” or “0”. 1 indicates that there might be more items in next page, 0 indicates otherwise.

Misc information

For most of the responses, the json payload return will only return fields that are not null. If a key in the json response is not present when you query the endpoint you will have to assume it is null.
There is also another case where some fields are skipped from the response json, this happens only if you don’t have enough permissions to view the data.

Default entity statuses

Value	comments
15	ACTIVE
4	APPROVAL_REQUIRED
3	APPROVAL_REJECTED
2	DRAFT
0	INACTIVE
-2	REPORTED
-3	SPAM
-100	DELETED

Reference Type List/Entity List

possible types
POST
COMMENT
REPLY
USER