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
Output
list
addons.list
List the add-ons installed on the account
Risk: read
object[]
Output full type
Output full type
Invoices
list
invoices.list
List invoices, filtered by update time or fetched in batches of ids
Risk: read
Output:
object[]
Output full type
Output full type
Jobs
get
jobs.get
Read one job by the id a webhook delivery carries
Risk: read
Output
result full type
result full type
Settings
get
settings.get
Read the business settings, including the webhook secret
Risk: read
Sites
get
sites.get
Read one storage site by id or code
Risk: read
Output
list
sites.list
List storage sites, optionally filtered by a search term
Risk: read
Output:
object[]
Output full type
Output full type
Unit Rentals
get
unitRentals.get
Read one unit rental, embedding its unit, owner and custom fields
Risk: read
Output
unit full type
unit full type
owner full type
owner full type
list
unitRentals.list
List unit rentals in batches of ids, embedding related records
Risk: read
Output:
object[]
Output full type
Output full type
update
unitRentals.update
Set custom fields on a unit rental, such as access codes
Risk: write
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
unit full type
unit full type
owner full type
owner full type
Units
list
units.list
List storage units with dimensions and default prices
Risk: read
object[]
Output full type
Output full type
Users
get
users.get
Read one user by id or email address
Risk: read
Output
list
users.list
List users, filtered by update time or fetched in batches of ids
Risk: read
Output:
object[]
Output full type
Output full type