Authentication

The Housemates API ensures data security by requiring a Bearer Token and a unique Partner ID for every API request. These credentials serve as a secure handshake, authenticating the calling client before granting access.

Each API request must include these credentials in the header. The Bearer Token authenticates the session, while the Partner ID identifies the partner platform. Any request without these valid credentials will be considered unauthorized and rejected.

In this section, we'll cover how to incorporate these credentials in your requests and how to handle related errors. Always keep your Bearer Token and Partner ID confidential and secure. For any security concerns, please contact our support team immediately.

Bearer token and API partner ID

To authenticate your API requests, you must use your API partner ID and access token. You should have received these credentials when you signed up for the Housemates API. . Here's an example of how to pass these credentials using cURL:

curl https://api.housemates.io/api/properties \
  -H "Authorization: Bearer {token}"
  -H "X-API-Partner-ID: {partner_id}"

Always keep your token and API partner ID confidential and secure. If you believe your token or API partner ID has been compromised, contact us immediately.

Using an SDK

If you use one of our official SDKs, you won't have to worry about any of the above — Provide your access token and API partner ID in configuration, and the client library will take care of the rest.