Quickstart

This guide will get you all set up and ready to use the Housemates Connect API. We'll cover how to get started using one of our API clients and how to make your first API request. We'll also look at where to go next to find all the information you need to take full advantage of our powerful REST API.

Choose your client

As of now, Housemates is offering PHP SDK which you can utilize in your PHP projects. We are also working on a JavaScript SDK which will be available soon. If you are not using PHP or JavaScript, you can still use the API by making HTTP requests directly to the API endpoints.

# cURL is most likely already installed on your machine
curl --version

Making your first API request

Once you have installed the api client, you are ready to make your first call to the Housemates Connect API. Below, you can see how to send a GET request to the Properties endpoint to get a list of all available properties. In the cURL example, results are limited to ten properties, the default page length for each client.

curl -i -X GET \
     "https://api.housemates.io/properties?per_page=10" \
  -H "Authorization: Bearer {token}" \
  -H "X-API-PARTNER-ID: {partnerId}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \

What's next?

Great, you're now set up with an API client and have made your first request to the API. Here are a few links that might be handy as you venture further into the Protocol API:

• Check out the Properties endpoint
• Learn about the different error messages