Getting Started

The Resident Management API allows Cusna partners and customers or third-party systems to programmatically manage resident data in Cusna dashboard. Using the Resident management API eliminates the need for property staff to manually enter data in the the dashboard.

Base URL

All API requests must use the following base URL:

https://www.cusna.io/api/1.1

Authentication

To make API call you need an Access Token.

To get the Access Token make a request to the Auth endpoint

Get Token

POSThttps://www.cusna.io/api/1.1/wf/auth

Body

application/json

passwordstring

emailstring

Response

200

Get Token

Body

application/json

responseobject

statusstring

Request

JavaScriptCurl

const response = await fetch('https://www.cusna.io/api/1.1/wf/auth', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify("{\n    \"email\":\"emailaddress\",\n    \"password\":\"password\"\n}"),
});
const data = await response.json();

Response

{
  "response": {
    "user_id": "text",
    "token": "text"
  },
  "status": "text"
}

Authenticate API requests by adding in the header the parameter

Authorization: Barear <token>

Organization ID

For some APIs, you need to provide your organization ID. YoOu can find the Organization ID in the Account page.