SiteworksBookingAccountType
An object holding information about an account and its associated users, properties and meter points, used for administering siteworks bookings.
Fields
Active campaigns for the account.
Name for this account. If one exists, the billing name of the portfolio will prepend this.
The brand of the account.
Data about whether or not an account can modify their payments.
Retrieve all market supply agreements under this account. Note that when active is set to false it actually means 'return both active and inactive agreements'.
Properties linked to the account now and in the future.
Siteworks requests associated to an account.
Deprecation
The 'siteworksRequests' field is deprecated.Please use getOnSiteJobsRequests instead.
- Marked as deprecated on 2026-09-08.
- Scheduled for removal on or after 2027-03-08.
The interest of an account in procuring smart meters.
The current status of the account.
The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.
Example
{
"accountType": "couple-dog-would-who-long",
"activeCampaigns": [SiteworksCampaignType],
"billingName": "race-house-lay-why-so",
"brand": "think-loss-magazine-choice-behavior",
"canModifyPayments": CanModifyPaymentsType,
"marketSupplyAgreements": AgreementConnection,
"number": "window-president-such-huge-concern",
"properties": [SiteworksBookingPropertyType],
"smets2Interest": "PRIORITY",
"status": "PENDING",
"users": [AccountUserType]
}