Skip to main content
New to Corsair? See API access, authentication, and error handling.

Addons

get

addons.get Read one add-on record with its operator credentials Risk: read
Input Output

list

addons.list List the add-ons installed on the account Risk: read
Input: empty object Output: object[]

Invoices

list

invoices.list List invoices, filtered by update time or fetched in batches of ids Risk: read
Input Output: object[]

Jobs

get

jobs.get Read one job by the id a webhook delivery carries Risk: read
Input Output

Settings

get

settings.get Read the business settings, including the webhook secret Risk: read
Input: empty object Output: empty object

Sites

get

sites.get Read one storage site by id or code Risk: read
Input Output

list

sites.list List storage sites, optionally filtered by a search term Risk: read
Input Output: object[]

Unit Rentals

get

unitRentals.get Read one unit rental, embedding its unit, owner and custom fields Risk: read
Input Output

list

unitRentals.list List unit rentals in batches of ids, embedding related records Risk: read
Input Output: object[]

update

unitRentals.update Set custom fields on a unit rental, such as access codes Risk: write
Input The only documented write. Sets custom fields on one rental, which is how access-control integrations store access codes and overlock flags under prefixed keys such as myAC_accessCode or myAC_overlocked. Output

Units

list

units.list List storage units with dimensions and default prices Risk: read
Input: empty object Output: object[]

Users

get

users.get Read one user by id or email address Risk: read
Input Output

list

users.list List users, filtered by update time or fetched in batches of ids Risk: read
Input Output: object[]