Buildium is a property management platform designed to help property managers handle leases, tenants, accounting, payments, and operational workflows. The Buildium integration within the Wrk platform allows you to automate common financial and property-management tasks by calling the Buildium REST API directly through prebuilt Wrk Actions.
This document provides an overview of how Buildium integrates into Wrk, how authentication works, best practices when calling the API, and a full list of available Wrk Actions.
Authentication
Buildium uses API key authentication based on a Client ID and Client Secret. Every API request must include both values within the Buildium Connected Account:
Input | Description |
Client ID | Your Buildium API key client ID |
Client Secret | Your Buildium API key client secret |
If either is missing or invalid, Buildium returns HTTP 401 Unauthorized.
How to Obtain API Keys
API keys can be created within the Buildium Developer Portal.
General API Behaviour
Sorting Results
Most list-style Buildium endpoints allow sorting using the orderby query parameter.
Examples:
Sort by a single property (ascending default):
orderby=LeaseType
Sort descending:
orderby=LeaseType desc
Sort by multiple properties:
orderby=Rent desc,City asc
Sorting for Paginated Data
If you plan to page through results, Buildium strongly recommends sorting on a unique property.
For example:
orderby=Date desc,Id asc
This prevents inconsistent data between pages and ensures that objects do not move between page boundaries.
Case sensitivity:
The orderby parameter itself is case-sensitive.
The field names inside the value are not case-sensitive.
Available Wrk Actions for Buildium
Wrk provides a curated set of Buildium Actions that map directly to Buildium’s most commonly used property-management APIs.
Perform an API call in Buildium
Create a bill in Buildium
Retrieve a bill from Buildium
Retrieve all bills from Buildium
Update a bill in Buildium
Delete a bill file in Buildium
Retrieve all charges from Buildium
Create a bill payment in Buildium
Retrieve a bill payment from Buildium
Retrieve all bill payments from Buildium
Retrieve a file for a bill from Buildium
Retrieve all files for a bill from Buildium
Retrieve a lease from Buildium
Retrieve a tenant from Buildium
Additional Resources
Buildium API Docs: https://developer.buildium.com/
Getting Started Guide: https://developer.buildium.com/#section/Getting-Started
Rate Limiting & Sorting Rules:https://developer.buildium.com/#section/API-Overview/Rate-Limiting