Skip to main content

Buildium — Application Overview

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:

InputDescription
Client IDYour Buildium API key client ID
Client SecretYour 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.

Documentation: https://developer.buildium.com/#section/Getting-Started/Creating-API-Keys

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.

  • Create a bill
  • Create a bill payment
  • Create a lease
  • Create a lease renewal
  • Create a move out
  • Create a note
  • Create a rental owner request
  • Create a resident request
  • Create a task category
  • Create a tenant
  • Create a to do request
  • Create a work order
  • Delete a bill file
  • Delete a move out
  • Delete task history file
  • Perform an API call
  • Retrieve a bill
  • Retrieve a bill payment
  • Retrieve a file for a bill
  • Retrieve a lease
  • Retrieve a lease renewal
  • Retrieve a move out
  • Retrieve a note
  • Retrieve a rental owner request
  • Retrieve a resident request
  • Retrieve a task
  • Retrieve a task category
  • Retrieve a task history
  • Retrieve a tenant
  • Retrieve a to do request
  • Retrieve a work order
  • Retrieve all bill payments
  • Retrieve all bills
  • Retrieve all charges
  • Retrieve all files for a bill
  • Retrieve all lease renewals
  • Retrieve all leases
  • Retrieve all move outs
  • Retrieve all notes
  • Retrieve all rental owner requests
  • Retrieve all resident requests
  • Retrieve all task categories
  • Retrieve all task history
  • Retrieve all tasks
  • Retrieve all tenants
  • Retrieve all to do requests
  • Retrieve all upcoming lease renewals
  • Retrieve all work orders
  • Retrieve rental owner contribution request
  • Update a bill
  • Update a lease
  • Update a note
  • Update a rental owner contribution request
  • Update a rental owner request
  • Update a resident request
  • Update a task category
  • Update a task history
  • Update a tenant
  • Update a to do request
  • Update a work order

Additional Resources​