dwell logo
API docs by Redocly

dwell API v1.05 (1.05)

Download OpenAPI specification:

UNBLK: tech@unblk.io URL: https://www.unblk.io/ License: Private Terms of Service

Added maintenance job status and filter by job status in maintenance request list for user

Auth

Logout from current session

Authenticates a user using a one-time passcode that was sent to them by email or SMS. This API validates the code provided by the user and returns user tokens.

Authorizations:
Api-Key
header Parameters
Api-Key
required
string
Example: 245c765b124a098d09ef8765....

Your API key provided by UNBLK

Request Body schema: application/json
session_id
required
string
refresh_token
required
string

Responses

Request samples

Content type
application/json
{
  • "session_id": "<generated ID from FE>",
  • "refresh_token": "<REFRESH_TOKEN>"
}

Response samples

Content type
text/plain
OK

Refreshes Access Tokens

Authenticate using existing refresh token

Authorizations:
Api-Key
header Parameters
Api-Key
required
string
Example: 245c765b124a098d09ef8765....

Your API key provided by UNBLK

Request Body schema: application/json
refresh_token
required
string
session_id
string

Responses

Request samples

Content type
application/json
{
  • "refresh_token": "<Refresh Token>",
  • "session_id": "<Generated ID from client-side>"
}

Response samples

Content type
application/json
{
  • "access_token": "<ACCESS_TOKEN>",
  • "refresh_token": "<REFRESH_TOKEN>",
  • "request_id": "6e03d440-b39b-4fa9-9ff0-ede6f8a17282"
}

Send OTP

Send a one-time passcode to a user by email or SMS.

Authorizations:
Api-Key
header Parameters
Api-Key
required
string
Example: 245c765b124a098d09ef8765....

Your API key provided by UNBLK

Request Body schema: application/json
channel
required
any
Enum: "email" "sms"
identifier_type
required
any
Enum: "email" "user_id"
session_id
required
string
identifier
required
string

Responses

Request samples

Content type
application/json
{
  • "channel": "email",
  • "identifier_type": "email",
  • "session_id": "<generated ID from FE>",
  • "identifier": "usera@dwell.io"
}

Response samples

Content type
application/json
{
  • "error_code": "string",
  • "error_message": "string",
  • "details": [
    ],
  • "request_id": "6e03d440-b39b-4fa9-9ff0-ede6f8a17282"
}

Authenticate OTP

Authenticates a user using a one-time passcode that was sent to them by email or SMS. This API validates the code provided by the user and returns user tokens.

Authorizations:
Api-Key
header Parameters
Api-Key
required
string
Example: 245c765b124a098d09ef8765....

Your API key provided by UNBLK

Request Body schema: application/json
identifier_type
required
any
Enum: "email" "user_id"
identifier
required
string
passcode
required
string
session_id
required
string

Responses

Request samples

Content type
application/json
{
  • "identifier_type": "email",
  • "identifier": "john.han@example.com",
  • "passcode": "A1b2C3",
  • "session_id": "GENERATED FROM CLIENT"
}

Response samples

Content type
application/json
{
  • "account": {
    },
  • "access_token": "<ACCESS_TOKEN>",
  • "refresh_token": "<REFRESH_TOKEN>",
  • "request_id": "6e03d440-b39b-4fa9-9ff0-ede6f8a17282"
}

Maintenance

Room Maintenance Categories

Retrieves the configuration for room maintenance, including available maintenance categories and their associated maintenance items. This configuration is used to standardize maintenance requests and organize them by type of work needed. Categories represent broad groups of maintenance work (e.g., Plumbing, Electrical, HVAC), while items are specific tasks or issues within each category (e.g., Leaking Faucet, Light Fixture Replacement, AC Not Cooling).

Authorizations:
Api-Key
query Parameters
country_code
string
Default: "AUS"

The country code of the room maintenance category.

category
string

The category of the room maintenance category.

_uid
string <uuid>

The uid of the room maintenance category.

Responses

Response samples

Content type
application/json
{
  • "categories": [
    ]
}

Maintenance Priority

Retrieves the list of Maintenance Priority.

Authorizations:
Api-Key
query Parameters
country_code
string
Default: "AUS"

The country code of the maintenance priority.

priority
string

The priority of the maintenance priority.

_uid
string <uuid>

The uid of the maintenance priority.

Responses

Response samples

Content type
application/json
{
  • "priority_list": [
    ]
}

Maintenance Job Status

Retrieves the list of Maintenance Job Status.

Authorizations:
Api-Key
query Parameters
country_code
string
Default: "AUS"

The country code of the maintenance job status.

_uid
string <uuid>

The uid of the maintenance job status.

Responses

Response samples

Content type
application/json
{
  • "job_statuses": [
    ]
}

Get User Maintenance Requests

Get User maintenance requests

Authorizations:
Api-KeybearerAuth
query Parameters
job_status
Array of strings
Default: "1. Job Submitted"
Items Enum: "1. Job Submitted" "2. Job In Progress" "3. Job Completed" "4. Wait for Part" "5. Wait for Contractor"
Example: job_status=1. Job Submitted,2. Job In Progress

The job status(es) to filter by. Can be a single status or array of statuses.

offset
integer >= 0
Default: 0

The number of items to skip before starting to collect the result set

limit
integer [ 1 .. 100 ]
Default: 20

The numbers of items to return

header Parameters
Authorization
required
string
Example: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.....

Bearer Token

Responses

Response samples

Content type
application/json
{
  • "requests": [
    ]
}

Create User Room Maintenance Request

Create a user room maintenance request

Authorizations:
Api-KeybearerAuth
header Parameters
Authorization
required
string
Example: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.....

Bearer Token

Request Body schema: application/json

maintenance request schema.

account_uid
required
string <uuid>
category_uid
required
string

Maintenance category in our side

category
required
string

Category of maintenance issue

item
required
string

Item specific of maintenance issue

description
string

Description of the maintenance issue

comments
string

Comments from the student

entry_id
required
integer

Starrez entry id of the student whoe made the request aka Occupant_EntryID

roomspace_id
required
integer

StarRez room space id

job_status
string
Default: "1. Job Submitted"

Current status of the maintenance job

priority
string
Default: "Non Urg - Priority 3"

Priority level of the maintenance job

Array of objects
enter_room_consent
boolean

Whether the student has consented maintenance staff to enter the room while they are around / not around.

Responses

Request samples

Content type
application/json
{
  • "account_uid": "fe1e864a-bb7d-4e1d-876f-e3b154fdbad4",
  • "category_uid": "fe1e864a-bb7d-4e1d-876f-e3b154fdbad4",
  • "category": "Electrical",
  • "item": "Ceiling Light",
  • "description": "Ceiling Light not working",
  • "comments": "Ceiling Light not working",
  • "entry_id": 765,
  • "roomspace_id": 1111,
  • "job_status": "1. Job Submitted",
  • "priority": "Non Urg - Priority 3",
  • "attachments": [],
  • "enter_room_consent": true
}

Response samples

Content type
application/json
{
  • "account_uid": "fe1e864a-bb7d-4e1d-876f-e3b154fdbad4",
  • "category_uid": "fe1e864a-bb7d-4e1d-876f-e3b154fdbad4",
  • "category": "Electrical",
  • "item_uid": "fe1e864a-bb7d-4e1d-876f-e3b154fdbad4",
  • "item": "Ceiling Light",
  • "description": "Ceiling Light not working",
  • "comments": "Ceiling Light not working",
  • "job_status": "1. Job Submitted",
  • "priority": "High",
  • "date_reported": "2024-10-07T14:42:00",
  • "starrez_entry_id": 765,
  • "starrez_roomspace_id": 1111,
  • "starrez_roomspace_maintenance_id": 1111,
  • "starrez_room_number": "05-231",
  • "attachments": [],
  • "icon": "https://assets.dwellstudentliving.io/user/room_space_maintenance/1111/broken-light.jpg",
  • "enter_room_consent": true,
  • "_uid": "b78a42c8-cf85-4c72-b78a-8c794858c6fd",
  • "_created": "2024-10-16T08:30:00Z",
  • "_updated": "2024-10-16T08:30:00Z"
}

Get User Maintenance Requests V2

Get User maintenance requests with enhanced timezone support. Returns date_reported_local field that converts UTC timestamps to the user's local timezone.

Authorizations:
Api-KeybearerAuth
query Parameters
user_timezone
string
Example: user_timezone=Australia/Sydney

User's timezone identifier (e.g., "Australia/Sydney", "America/New_York"). Used to convert UTC timestamps to local time. If not provided, defaults to UTC.

job_status
Array of strings
Default: "1. Job Submitted"
Items Enum: "1. Job Submitted" "2. Job In Progress" "3. Job Completed" "4. Wait for Part" "5. Wait for Contractor"
Example: job_status=1. Job Submitted,2. Job In Progress

The job status(es) to filter by. Can be a single status or array of statuses.

offset
integer >= 0
Default: 0

The number of items to skip before starting to collect the result set

limit
integer [ 1 .. 100 ]
Default: 20

The numbers of items to return

header Parameters
Authorization
required
string
Example: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.....

Bearer Token

Responses

Response samples

Content type
application/json
{
  • "requests": [
    ]
}

Updates User Room Maintenance Request

Updates a user room maintenance request

Authorizations:
Api-Key
path Parameters
maintenance_id
required
string <uuid>
Example: 12c4a8c4-13ad-4b95-9dc3-6fab292fe524

uid of maintenance request

header Parameters
Api-Key
required
string
Example: 245c765b124a098d09ef8765....

Your API key provided by UNBLK

Request Body schema: application/json

maintenance request schema.

job_status
string

Current status of the maintenance job

Array of objects
enter_room_consent
boolean

Whether the student has consented maintenance staff to enter the room while they are around / not around.

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "account_uid": "fe1e864a-bb7d-4e1d-876f-e3b154fdbad4",
  • "category_uid": "fe1e864a-bb7d-4e1d-876f-e3b154fdbad4",
  • "category": "Electrical",
  • "item_uid": "fe1e864a-bb7d-4e1d-876f-e3b154fdbad4",
  • "item": "Ceiling Light",
  • "description": "Ceiling Light not working",
  • "comments": "Ceiling Light not working",
  • "job_status": "1. Job Submitted",
  • "priority": "High",
  • "date_reported": "2024-10-07T14:42:00",
  • "starrez_entry_id": 765,
  • "starrez_roomspace_id": 1111,
  • "starrez_roomspace_maintenance_id": 1111,
  • "starrez_room_number": "05-231",
  • "attachments": [],
  • "icon": "https://assets.dwellstudentliving.io/user/room_space_maintenance/1111/broken-light.jpg",
  • "enter_room_consent": true,
  • "_uid": "b78a42c8-cf85-4c72-b78a-8c794858c6fd",
  • "_created": "2024-10-16T08:30:00Z",
  • "_updated": "2024-10-16T08:30:00Z"
}

Payment

Get Bank Details

Authorizations:
Api-Key
query Parameters
country_code
string
Example: country_code=AUS

Filter by country code (ISO3)

property_uid
string <uuid>

Filter by property UUID

Responses

Response samples

Content type
application/json
{
  • "bank_details": [
    ]
}

Feedback

Get Feedback Category

Authorizations:
Api-Key
query Parameters
country_code
string
Example: country_code=AUS

Filter by country code (ISO3)

_uid
string <uuid>
Example: _uid=123e4567-e89b-12d3-a456-426614174000

Filter by feedback category UUID

category
string
Example: category=General Feedback

Filter by category

Responses

Response samples

Content type
application/json
{
  • "feedback_categories": [
    ]
}

Get User Feedback

Get user feedback list

Authorizations:
Api-KeybearerAuth
query Parameters
category
string

The feedback category to filter by

status
Array of strings
Default: "Submitted"
Items Enum: "Submitted" "Reviewed" "Resolved"
Example: status=Submitted,Reviewed

The feedback status(es) to filter by

offset
integer >= 0
Default: 0

The number of items to skip

limit
integer [ 1 .. 100 ]
Default: 20

The numbers of items to return

header Parameters
Authorization
required
string
Example: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.....

Bearer Token

Responses

Response samples

Content type
application/json
{
  • "feedbacks": [
    ]
}

Create User Feedback

Create a user feedback

Authorizations:
Api-KeybearerAuth
header Parameters
Authorization
required
string
Example: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.....

Bearer Token

Request Body schema: application/json

User feedback schema

feedback_category_uid
required
string <uuid>

Feedback category get from the config

details
string

Details of the feedback

status
required
string
Default: "Submitted"
Enum: "Submitted" "Reviewed" "Resolved"

Current status of the feedback

comments
string

Comments from the student

Array of objects

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "account_uid": "fe1e864a-bb7d-4e1d-876f-e3b154fdbad4",
  • "feedback_category": "General Feedback",
  • "feedback_category_uid": "fe1e864a-bb7d-4e1d-876f-e3b154fdbad4",
  • "details": "The facility is very clean but the room is too small",
  • "status": "Submitted",
  • "comments": "I prefer to have a bigger room",
  • "attachments": [],
  • "_uid": "b78a42c8-cf85-4c72-b78a-8c794858c6fd",
  • "_created": "2024-10-16T08:30:00Z",
  • "_updated": "2024-10-16T08:30:00Z"
}

Account

Get Account

Get Account details

Authorizations:
Api-KeybearerAuth
header Parameters
Authorization
required
string
Example: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.....

Bearer Token

Responses

Response samples

Content type
application/json
{
  • "account_uid": "12c4a8c4-13ad-4b95-9dc3-6fab292fe524",
  • "starrez_entry_id": 765,
  • "first_name": "John",
  • "last_name": "Doe",
  • "email": "john.doe@example.com",
  • "contact_email": "john.doe@example.com",
  • "mobile": 1234567890,
  • "mobile_country_code": 61,
  • "birth_date": "1990-01-01",
  • "profile_photo_url": "https://image.url.com",
  • "country_code": "AUS",
  • "emergency_contact": {
    },
  • "status": {
    },
  • "room_info": {
    },
  • "starrez_booking_id": 111
}

Update user account

Update user details

Authorizations:
Api-KeybearerAuth
header Parameters
Api-Key
required
string
Example: 245c765b124a098d09ef8765....

Your API key provided by UNBLK

Authorization
required
string
Example: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.....

Bearer Token

Request Body schema: application/json

account schema.

contact_email
required
string
mobile
number
mobile_country_code
number
profile_photo_url
string <url>
country_code
string

ISO ALPHA-3 code

object (v1EmergencyContactDetail)

Responses

Request samples

Content type
application/json
{
  • "contact_email": "john.doe@example.com",
  • "mobile": 1234567890,
  • "mobile_country_code": 61,
  • "profile_photo_url": "https://image.url.com",
  • "country_code": "AUS",
  • "emergency_contact": {
    }
}

Response samples

Content type
application/json
{
  • "account_uid": "12c4a8c4-13ad-4b95-9dc3-6fab292fe524",
  • "starrez_entry_id": 765,
  • "first_name": "John",
  • "last_name": "Doe",
  • "email": "john.doe@example.com",
  • "contact_email": "john.doe@example.com",
  • "mobile": 1234567890,
  • "mobile_country_code": 61,
  • "birth_date": "1990-01-01",
  • "profile_photo_url": "https://image.url.com",
  • "country_code": "AUS",
  • "emergency_contact": {
    },
  • "status": {
    },
  • "room_info": {
    },
  • "starrez_booking_id": 111
}

Get Account DateTime

Get current date and time for the user's property location. Returns formatted datetime information based on the user's assigned property city.

Authorizations:
Api-KeybearerAuth
query Parameters
force_day
string

(TESTING ONLY) Forces the API to return a date corresponding to the specified day of the week. This parameter is only active in non-production environments. If an invalid day is provided, a 400 error will be returned. Valid values (case-insensitive): Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday.

header Parameters
Authorization
required
string
Example: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.....

Bearer Token

Responses

Response samples

Content type
application/json
{
  • "date": "01-15-2024",
  • "day_of_the_week": "Monday",
  • "time": "14:30",
  • "timezone": "Australia/Melbourne"
}

Create Receipts related to Account

Create transaction / billing receipt for an account

Authorizations:
Api-Key
header Parameters
Api-Key
required
string
Example: 245c765b124a098d09ef8765....

Your API key provided by UNBLK

Request Body schema: application/json

account schema.

required
Array of objects

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{}

Parcel

List User Parcel

List User parcels

Authorizations:
Api-KeybearerAuth
query Parameters
offset
integer >= 0
Default: 0

The number of items to skip before starting to collect the result set

limit
integer [ 1 .. 100 ]
Default: 20

The numbers of items to return

header Parameters
Authorization
required
string
Example: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.....

Bearer Token

Responses

Response samples

Content type
application/json
{
  • "parcels": [
    ]
}

List User Parcel V2

List User parcels with provider information

Authorizations:
Api-KeybearerAuth
query Parameters
offset
integer >= 0
Default: 0

The number of items to skip before starting to collect the result set

limit
integer [ 1 .. 100 ]
Default: 20

The numbers of items to return

header Parameters
Authorization
required
string
Example: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.....

Bearer Token

Responses

Response samples

Content type
application/json
{
  • "parcels": [
    ]
}

Create User Parcel V2

Create a new parcel with provider information

Authorizations:
Api-KeybearerAuth
header Parameters
Authorization
required
string
Example: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.....

Bearer Token

Request Body schema: application/json
required
starrez_parcel_id
required
number
starrez_entry_id
required
number
parcel_type
required
string
shipping_type
string
address_type
string
description
string
issue_date
string <date>
starrez_date_modified
string <date>
parcel_status
required
string
tracking_number
required
string
receipt_date
string <date>
comments
string
starrez_parcel_status_enum
number
locker_location
string or null
provider
string or null
provider_qr_code_url
string or null
provider_pin
string or null
(object or null) or (object or null) or (object or null) or (object or null) or (object or null) or (object or null)
Default: {}

Responses

Request samples

Content type
application/json
{
  • "starrez_parcel_id": 765,
  • "starrez_entry_id": 765,
  • "parcel_type": "Large Parcel",
  • "shipping_type": "DHL",
  • "address_type": "Home",
  • "description": "Big brown box",
  • "issue_date": "2018-11-05T14:31:00",
  • "starrez_date_modified": "2018-11-05T14:31:00",
  • "parcel_status": "Issued",
  • "tracking_number": "1223456",
  • "receipt_date": "2018-11-05T14:31:00",
  • "comments": "bleh",
  • "starrez_parcel_status_enum": 1,
  • "locker_location": "Building A, Locker 123",
  • "provider": "ParcelPoint",
  • "provider_qr_code_url": "https://example.com/qr/123",
  • "provider_pin": "1234",
  • "provider_parcel_data": { }
}

Response samples

Content type
application/json
{
  • "starrez_parcel_id": 765,
  • "starrez_entry_id": 765,
  • "parcel_type": "Large Parcel",
  • "shipping_type": "DHL",
  • "address_type": "Home",
  • "description": "Big brown box",
  • "issue_date": "2018-11-05T14:31:00",
  • "starrez_date_modified": "2018-11-05T14:31:00",
  • "parcel_status": "Issued",
  • "tracking_number": "1223456",
  • "receipt_date": "2018-11-05T14:31:00",
  • "comments": "bleh",
  • "starrez_parcel_status_enum": 1,
  • "locker_location": "Building A, Locker 123",
  • "provider": "ParcelPoint",
  • "provider_qr_code_url": "https://example.com/qr/123",
  • "provider_pin": "1234",
  • "provider_parcel_data": { }
}

Update User Parcel V2

Update an existing parcel with provider information

Authorizations:
Api-KeybearerAuth
header Parameters
Authorization
required
string
Example: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.....

Bearer Token

Request Body schema: application/json
required
starrez_parcel_id
required
number
starrez_entry_id
required
number
parcel_type
required
string
shipping_type
string
address_type
string
description
string
issue_date
string <date>
starrez_date_modified
string <date>
parcel_status
required
string
tracking_number
required
string
receipt_date
string <date>
comments
string
starrez_parcel_status_enum
number
locker_location
string or null
provider
string or null
provider_qr_code_url
string or null
provider_pin
string or null
(object or null) or (object or null) or (object or null) or (object or null) or (object or null) or (object or null)
Default: {}

Responses

Request samples

Content type
application/json
{
  • "starrez_parcel_id": 765,
  • "starrez_entry_id": 765,
  • "parcel_type": "Large Parcel",
  • "shipping_type": "DHL",
  • "address_type": "Home",
  • "description": "Big brown box",
  • "issue_date": "2018-11-05T14:31:00",
  • "starrez_date_modified": "2018-11-05T14:31:00",
  • "parcel_status": "Issued",
  • "tracking_number": "1223456",
  • "receipt_date": "2018-11-05T14:31:00",
  • "comments": "bleh",
  • "starrez_parcel_status_enum": 1,
  • "locker_location": "Building A, Locker 123",
  • "provider": "ParcelPoint",
  • "provider_qr_code_url": "https://example.com/qr/123",
  • "provider_pin": "1234",
  • "provider_parcel_data": { }
}

Response samples

Content type
application/json
{
  • "starrez_parcel_id": 765,
  • "starrez_entry_id": 765,
  • "parcel_type": "Large Parcel",
  • "shipping_type": "DHL",
  • "address_type": "Home",
  • "description": "Big brown box",
  • "issue_date": "2018-11-05T14:31:00",
  • "starrez_date_modified": "2018-11-05T14:31:00",
  • "parcel_status": "Issued",
  • "tracking_number": "1223456",
  • "receipt_date": "2018-11-05T14:31:00",
  • "comments": "bleh",
  • "starrez_parcel_status_enum": 1,
  • "locker_location": "Building A, Locker 123",
  • "provider": "ParcelPoint",
  • "provider_qr_code_url": "https://example.com/qr/123",
  • "provider_pin": "1234",
  • "provider_parcel_data": { }
}

Transactions

Get User Transactions

Get User transactions

Authorizations:
Api-KeybearerAuth
query Parameters
entry_id
integer >= 0
Default: 0

The entry id to filter by

offset
integer >= 0
Default: 0

The number of items to skip before starting to collect the result set

limit
integer [ 1 .. 100 ]
Default: 20

The numbers of items to return

header Parameters
Authorization
required
string
Example: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.....

Bearer Token

Responses

Response samples

Content type
application/json
{
  • "transactions": [
    ]
}

Get User Transaction Types

Balance, Deposit, Withdrawal, Transfer, Payment, Refund, Charge, Credit, Debit

Authorizations:
Api-KeybearerAuth
query Parameters
transaction_type
integer
Enum: 0 1 2 3 4 5

The transaction type to filter by. Possible values are: 0 - Telephone 1 - Transfer 2 - Payment 3 - Refund 4 - Adjustment 5 - Charge Default is Balance

header Parameters
Authorization
required
string
Example: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.....

Bearer Token

Responses

Response samples

Content type
application/json
{
  • "transaction_type": 3,
  • "transaction_type_description": "Refund",
  • "total_amount": 1
}

Get User Transactions - Rental Dues

Get User transactions for rental dues

Authorizations:
Api-KeybearerAuth
header Parameters
Authorization
required
string
Example: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.....

Bearer Token

Responses

Response samples

Content type
application/json
{
  • "current_server_date": "2025-02-09T14:32:59",
  • "entry_id": 10839,
  • "charge_group_id": 6,
  • "charge_group_description": "EEA_Residential Rent",
  • "amount": 1,
  • "tax_amount": 0
}

Get User Billing Due

Get User billing due

Authorizations:
Api-KeybearerAuth
query Parameters
due_dates
required
Array of strings <date> [ items <date > ]

The charge cycle date to filter by

header Parameters
Authorization
required
string
Example: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.....

Bearer Token

Responses

Response samples

Content type
application/json
{
  • "current_charge_cycle": "2025-02-09T14:32:59",
  • "next_charge_cycle": "2025-02-09T14:32:59",
  • "next_charge_amount": 1,
  • "entry_id": 10839,
  • "overdues": [ ]
}

Get User Transactions - Dues

Get User transactions for dues

Authorizations:
Api-KeybearerAuth
header Parameters
Authorization
required
string
Example: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.....

Bearer Token

Responses

Response samples

Content type
application/json
{
  • "current_server_date": "2025-02-09T14:32:59",
  • "entry_id": 10839,
  • "amount": 1
}

Media

Create Media Upload URL

Create a user media upload presigned url

Authorizations:
Api-KeybearerAuth
header Parameters
Authorization
required
string
Example: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.....

Bearer Token

Request Body schema: application/json

media upload url request schema.

key
required
string

key to use to add to bucket

prefix
string
Enum: "RoomSpaceMaintenance" "Entry" "Feedback" "Receipt"

prefix to use

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "prefix": "RoomSpaceMaintenance"
}

Response samples

Content type
application/json
{
  • "presigned_url": "string"
}

Property

Get Properties

Get a Single Property

Authorizations:
Api-Key
query Parameters
starrez_property_id
number
Example: starrez_property_id=2

StarRez Property ID

_uid
string
Example: _uid=12c4a8c4-13ad-4b95-9dc3-6fab292fe524

Property UUID

country
string
Example: country=AUS

Property country code

offset
integer

Number of items to skip

limit
integer
Example: limit=20

Maximum number of items to return

Responses

Response samples

Content type
application/json
{
  • "properties": [
    ]
}

RoomType

List RoomTypes

List RoomType object

Authorizations:
Api-Key
header Parameters
Api-Key
required
string
Example: 245c765b124a098d09ef8765....

Your API key provided by UNBLK

Responses

Response samples

Content type
application/json
{}

Get RoomType by Id

Get RoomType object

Authorizations:
Api-Key
path Parameters
room_type_id
required
string <uuid>
Example: 12c4a8c4-13ad-4b95-9dc3-6fab292fe524

room type id

header Parameters
Api-Key
required
string
Example: 245c765b124a098d09ef8765....

Your API key provided by UNBLK

Responses

Response samples

Content type
application/json
{}

RoomRate

List RoomRate

Creates a new RoomRate object

Authorizations:
Api-Key
header Parameters
Api-Key
required
string
Example: 245c765b124a098d09ef8765....

Your API key provided by UNBLK

Responses

Response samples

Content type
application/json
{
  • "room_rates": [
    ]
}

Room

List Room

Creates a new Room object

Authorizations:
Api-Key

Responses

Response samples

Content type
application/json
{}

Form

Get Form Type(s)

Create a Form type. Form types contains all the integration configurations.

Authorizations:
Api-Key
query Parameters
_uid
string <uuid>
Example: _uid=b78a42c8-cf85-4c72-b78a-8c794858c6fd

form type id

form_type
string
Example: form_type=en-aus-contact-us

form type unique code

version
number
Example: version=2

form type version

country_code
string
Example: country_code=AUS

country code in uppercase format, ISO3 format

header Parameters
Api-Key
required
string
Example: 245c765b124a098d09ef8765....

Your API key provided by UNBLK

Responses

Response samples

Content type
application/json
{
  • "form_types": [
    ]
}

Get Form Submission(s)

Get Form submission(s). Filter by id, request_id, version and country_code

Authorizations:
Api-Key
query Parameters
id
string <uuid>
Example: id=b78a42c8-cf85-4c72-b78a-8c794858c6fd

form type id

submission_request_id
string <uuid>
Example: submission_request_id=b78a42c8-cf85-4c72-b78a-8c794858c6fd

form submission request id

form_type
string
Example: form_type=en-aus-contact-us

form type unique code

form_type_version
number
Example: form_type_version=2

form type version

country_code
string
Example: country_code=AUS

country code in uppercase format, ISO3 format

order_by
string
Enum: "_created" "_updated"
Example: order_by=AUS

Order by

direction
string
Default: "desc"
Enum: "desc" "asc"
Example: direction=AUS

direction of order

header Parameters
Api-Key
required
string
Example: 245c765b124a098d09ef8765....

Your API key provided by UNBLK

Responses

Response samples

Content type
application/json
{
  • "form_submissions": [
    ]
}

StarRez

StarRez - Room Type Rates

Retrieves Room Type Rates from StarRez. The API get all details from StarRez API via workflow (Windmill)

Authorizations:
Api-Key
query Parameters
id
string

The room type id of the room type rate.

_uid
string <uuid>

The uid of the room type rate.

room_location_id
number
Example: room_location_id=1

The location id of the room type rate. 1 = Melbourne, 2 = East End Adelaide

offset
number

The offset of the room type rate.

limit
number
Default: 20
Example: limit=20

The limit of the room type rate.

Responses

Response samples

Content type
application/json
{
  • "room_type_rates": [
    ]
}

Create StarRez Room Type Rate

Create a StarRez Room Type Rate.

Authorizations:
Api-Key
header Parameters
Api-Key
required
string
Example: 245c765b124a098d09ef8765....

Your API key provided by UNBLK

Request Body schema: application/json
id
required
integer

Primary identifier for the room type rate

room_location_id
required
integer

ID of the room location

room_type_id
required
integer

ID of the room type

room_rate_id
required
integer

ID of the room rate

room_rate_session_id
required
integer

ID of the room rate session

term_session_id
required
integer

ID of the term session

amount
required
number <decimal>

The rate amount

amount_add_on
number or null <decimal>

Additional amount charges

term_session
required
string

Description of the term session

term_session_duration
string or null

Duration of the term session

room_type
required
string

Description of the room type

room_location
required
string

Description of the room location

room_rate_session
required
string

Description of the room rate session

check_in_date
required
string <date-time>

Check-in date and time

check_out_date
required
string <date-time>

Check-out date and time

contract_date_start
required
string <date-time>

Contract start date and time

contract_date_end
required
string <date-time>

Contract end date and time

date_modified
required
string <date-time>

Last modification date and time

available
required
boolean

Availability status of the room type rate

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "room_location_id": 0,
  • "room_type_id": 0,
  • "room_rate_id": 0,
  • "room_rate_session_id": 0,
  • "term_session_id": 0,
  • "amount": 299.99,
  • "amount_add_on": 50,
  • "term_session": "2024 Term 1",
  • "term_session_duration": "12 weeks",
  • "room_type": "Studio Apartment",
  • "room_location": "North Tower",
  • "room_rate_session": "Standard Rate 2024",
  • "check_in_date": "2024-01-01T00:00:00Z",
  • "check_out_date": "2024-01-01T00:00:00Z",
  • "contract_date_start": "2024-01-01T00:00:00Z",
  • "contract_date_end": "2024-01-01T00:00:00Z",
  • "date_modified": "2024-01-01T00:00:00Z",
  • "available": true
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "room_location_id": 0,
  • "room_type_id": 0,
  • "room_rate_id": 0,
  • "room_rate_session_id": 0,
  • "term_session_id": 0,
  • "amount": 299.99,
  • "amount_add_on": 50,
  • "term_session": "2024 Term 1",
  • "term_session_duration": "12 weeks",
  • "room_type": "Studio Apartment",
  • "room_location": "North Tower",
  • "room_rate_session": "Standard Rate 2024",
  • "check_in_date": "2024-01-01T00:00:00Z",
  • "check_out_date": "2024-01-01T00:00:00Z",
  • "contract_date_start": "2024-01-01T00:00:00Z",
  • "contract_date_end": "2024-01-01T00:00:00Z",
  • "date_modified": "2024-01-01T00:00:00Z",
  • "available": true,
  • "_uid": "b78a42c8-cf85-4c72-b78a-8c794858c6fd",
  • "_created": "2024-10-16T08:30:00Z",
  • "_updated": "2024-10-16T08:30:00Z"
}

v2

Get User Transactions - Dues

Get User transactions for dues

Authorizations:
Api-KeybearerAuth
header Parameters
Authorization
required
string
Example: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.....

Bearer Token

Responses

Response samples

Content type
application/json
{
  • "current_server_date": "2025-02-09T14:32:59",
  • "entry_id": 10839,
  • "amount": 1
}

Public

Get Room Rates

Get room rates with filtering options. Allows the OTAs and other partners to get the list of room rates. All parameters are optional.

Authorizations:
Api-Key
query Parameters
id
number
Example: id=5479

The unique identifier for the room rate, can be used to filter the room rate availability.

room_location_id
number
Example: room_location_id=1

The unique identifier for the room location, can be used to filter the room rate availability.

offset
integer >= 0
Default: 0

The number of items to skip before starting to collect the result set

limit
integer [ 1 .. 100 ]
Default: 20

The numbers of items to return

Responses

Response samples

Content type
application/json
{
  • "room_rates": [
    ]
}

Parcel Provider

Webhook Parcel Provider Delivery Events

Post delivery events to the API. Allows the Parcel Providers to call webhooks when a delivery event occurs.

Authorizations:
Api-Key
path Parameters
provider
required
string
Value: "groundfloor"
Request Body schema: application/json
property name*
additional property
any

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "request_id": "266ea41d-adf5-480b-af50-15b940c2b846",
  • "status": "string"
}