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

Get user list

Endpoint

GET /api/v1/users/{msid}

Query param options

For common paging options refer this

Query parameters default comments
sort_by user_id available options are user_id, joined, name.
order desc possible values asc or desc
status 10 To filter records by status, default is Active records. Other status options

Note: Listing records is a slow operation, make sure your code can handle it appropriately.

Response parameters

[
  {
    "user_id": 177,
    "sid": "TwM0e5z2gGE7VyDcY5c6ZeObphM",
    "msid": "177.TwM0e5z2gGE7VyDcY5c6ZeObphM",
    "username": "Joshuah_Frami",
    "user_avatar": "http://placeimg.com/640/480/nature",
    "first_name": "Dovie",
    "role_id": 2,
    "user_status": 10,
    "created_at": "2022-04-05T01:15:57Z"
  },
  {
    "user_id": 176,
    "sid": "Dm0f0T0syODtqfQ0HP4Tp1TX8VD",
    "msid": "176.Dm0f0T0syODtqfQ0HP4Tp1TX8VD",
    "username": "Esperanza",
    "user_avatar": "http://placeimg.com/640/480/nature",
    "first_name": "Esperanza",
    "role_id": 4,
    "user_status": 10,
    "created_at": "2022-04-05T01:15:53Z"
  }
]