Clients & Sites Endpoints (cont.)

Clients & Sites (continued)

Area (Client) — continued

GET /Client — List Clients (continued)

Parameter	Type	Description
idonly	boolean	Return only Area IDs (not compatible with pagination)
includeactive	boolean	Include active clients
includeazuretenants	boolean	Include Azure tenant info
includeinactive	boolean	Include inactive clients
includeinvoicetemplatename	boolean	Include invoice template names
includenotes	boolean	Include client notes
include_custom_fields	string	Comma-separated Custom Field IDs to include
integration_tenantids	array(integer)	Filter by integration tenant IDs
integration_type	string	Filter by integration type
issentinel	boolean	Only Sentinel clients
lastupdatefromdate	boolean	Include lastupdatefromdate field
lastupdatetodate	boolean	Include lastupdatetodate field
order–order5	string	Sort fields
orderdesc–orderdesc5	boolean	Descending sort per field
page_no	integer	Page number
page_size	integer	Page size
pageinate	boolean	Enable pagination
search	string	Filter clients matching search string
search_name_only	string	Search client name only
sentinelid	integer	Filter by Sentinel ID
sitefields	string	Site field IDs to include
snowclients	boolean	Only Snow clients
ticketarea_id	integer	Filter by ticket area
toplevel_id	integer	Filter by top level
view_id	integer	View configuration ID

Response: Area_View

POST /Client — Create Client

Creates one or more client (Area) records.

Request Body: Array of Area objects.

Response: Area (201 Created)

GET /Client/{id} — Get Client

Returns a single client by ID.

Parameter	Type	Description
id	integer (path)	Client ID (required)
domain	string	Permission domain filter (e.g. opps)
getavailablerts	boolean	Include list of ticket types the client can log
includeactivity	boolean	Include ticket activity
includedetails	boolean	Include extra detail objects
includeperiods	boolean	Include pre-pay periods
includeprepay	boolean	Include pre-pay balance info
tickettype_id	integer	Ticket type context

Response: Area

DELETE /Client/{id} — Delete Client

Deletes a client by ID.

Parameter	Type	Description
id	integer (path)	Client ID (required)

GET /Client/me — Get Current Client

Returns the client record for the currently authenticated end-user. Useful for portal contexts.

Response: Area

POST /Client/NewAccountsId — Assign New Accounts ID

Updates a client with a new accounts integration ID.

Request Body: Array of Area objects.

POST /Client/PaymentMethodUpdate — Update Payment Method

Updates payment method on a client record.

Request Body: Array of Area objects.

Area (Client) schema key fields:

Field	Type	Description
id	integer	Client ID
name	string	Client name
toplevel_id	integer	Top-level group ID
toplevel_name	string	Top-level group name
inactive	boolean	Whether client is inactive
colour	string	Display colour
main_site_id	integer	Primary site ID
main_site_name	string	Primary site name
datecreated	datetime	Client creation date
notes	string	Client notes
website	string	Client website
accountsemailaddress	string	Accounts email
accountsfirstname / accountslastname	string	Accounts contact name
accountsccemailaddress / accountsbccemailaddress	string	CC/BCC email for accounts
pritech	integer	Primary technician ID
pritech_name	string	Primary technician name
sectech	integer	Secondary technician ID
accountmanagertech	integer	Account manager technician ID
accountmanagertech_name	string	Account manager name
open_ticket_count	integer	Open ticket count
onhold_ticket_count	integer	On-hold ticket count
total_ticket_count	integer	Total ticket count
opened_thismonth_count	integer	Tickets opened this month
chargehours	number	Charge hours (billing)
hourlyrate	number	Hourly rate
periodcharge	number	Period charge amount
chargeperiod	integer	Charge period type
invoiceyes	boolean	Whether to invoice
dontinvoice	boolean	Suppress invoicing
invoicetemplate	string	Invoice template
paymentterms	integer	Payment terms (days)
prepaytotal	number	Total pre-pay amount
prepayused	number	Used pre-pay amount
prepaybalance	number	Remaining pre-pay balance
billingtemplate_id	integer	Billing template ID
item_tax_code	integer	Item tax code
service_tax_code	integer	Service tax code
contract_tax_code	integer	Contract tax code
prepay_tax_code	integer	Pre-pay tax code
surchargeid	integer	Surcharge ID
discountperc	number	Discount percentage
customfields	array	Custom fields
site_fields	array	Site-level fields
custombuttons	array	Custom action buttons
attachments	array	Client attachments
popup_notes	array	Popup alert notes
faqlists	array	Associated FAQ lists
allowall_tickettypes	boolean	Allow all ticket types
allowed_tickettypes	array	Restricted ticket type list
billingplans	array	Billing plan details
periods	array	Pre-pay periods
areaitems	array	Recurring items
site_update	array	Sites to create/update with client
domain	string	Client domain
tax_number	string	Tax/VAT number
xeroid	string	Xero integration ID
connectwiseid	integer	ConnectWise integration ID
autotaskid	integer	Autotask integration ID
datto_id	string	Datto integration ID
hubspot_id	string	HubSpot integration ID
auvik_id	string	Auvik integration ID
passportal_id	integer	Passportal integration ID
ninjarmmid	integer	NinjaRMM integration ID
stripe_customer_id	string	Stripe customer ID
stripe_payment_method_id	string	Stripe payment method ID
liongardid	integer	Liongard integration ID
kaseyaid	string	Kaseya integration ID
trading_name	string	Trading name
portalcolour	string	Portal brand colour override
portal_logo	string	Portal logo override
newclient_sitename	string	Site name when creating new client
newclient_phonenumber	string	Site phone when creating new client
newclient_domain	string	Domain when creating new client
newclient_contactname	string	Contact name when creating new client
newclient_contactemail	string	Contact email when creating new client
newclient_delivery_address	AddressStore	Delivery address when creating new client

---

AreaAzureTenant

Links clients/sites to Azure tenants for Microsoft CSP/Entra integration.

GET /AreaAzureTenant — List Azure Tenant Links

Returns Azure tenant link records.

Parameter	Type	Description
azure_tenant_id	string	Filter by Azure tenant GUID
client_id	integer	Filter by client ID
details_id	integer	Filter by details ID
ignore_decrypt	boolean	Skip credential decryption
notset	boolean	Return only unlinked records
returnalliflinked	boolean	Return all if already linked
site_id	integer	Filter by site ID

Response: 200 OK

---

AreaItem (Recurring Items)

Represents recurring billing items attached to a client.

GET /RecurringItem — List Recurring Items

Returns recurring item records for a client.

Parameter	Type	Description
client_id	integer	Filter by client ID
pending_recurring_invoice	boolean	Only items pending recurring invoice

Response: 200 OK

---

AreaNote (CRM Notes)

Represents CRM notes attached to clients.

GET /CRMNote — List CRM Notes

Returns CRM notes.

Parameter	Type	Description
client_id	integer	Filter by client ID
count	integer	Number of results
supplier_id	integer	Filter by supplier ID
toplevel_id	integer	Filter by top level

Response: 200 OK

POST /CRMNote — Create CRM Note

Creates one or more CRM notes.

Request Body: Array of AreaNote objects.

GET /CRMNote/{id} — Get CRM Note

Returns a single CRM note by ID.

Parameter	Type	Description
id	integer (path)	CRM Note ID (required)
includedetails	boolean	Include extra details

DELETE /CRMNote/{id} — Delete CRM Note

Deletes a CRM note by ID.

Parameter	Type	Description
id	integer (path)	CRM Note ID (required)

---

AreaPopup (Popup Notes)

Alert notes that display as popups when viewing a client or site.

GET /PopupNote — List Popup Notes

Returns popup notes.

Parameter	Type	Description
client_id	integer	Filter by client ID
showall	boolean	Show all notes including read
site_id	integer	Filter by site ID
user_id	integer	Filter by user ID

Response: 200 OK

POST /PopupNote/read — Mark Popup Note as Read

Marks a popup note as read.

Request Body: Array of AreaPopup objects.

AreaPopup schema:

Field	Type	Description
id	integer	Popup note ID
client_id	integer	Associated client ID
site_id	integer	Associated site ID
user_id	integer	Associated user ID
date_created	datetime	Creation timestamp
note	string	Note content
dismissable	boolean	Whether user can dismiss
read_status	integer	Read status flag
displaymodal	boolean	Show as modal dialog
displayhtml	boolean	Render as HTML
limitdaterange	boolean	Apply date range restriction
startdate	datetime	Display start date
enddate	datetime	Display end date

---

AreaRequestType

Defines which request/ticket types are available to a client.

GET /AreaRequestType — List Area Request Types

Returns all area request type records. No documented query parameters.

GET /AreaRequestType/{id} — Get Area Request Type

Returns a single area request type by ID.

Parameter	Type	Description
id	integer (path)	AreaRequestType ID (required)
includedetails	boolean	Include extra details

---

Response Wrapper Schemas

Company_View

Paginated list response for companies.

Field	Type	Description
page_no	integer	Current page number
page_size	integer	Page size
record_count	integer	Total record count
suppliers	array(Company_List)	Company records
columns_id	integer	Column configuration ID
columns	array	Column definitions

Site_List (lightweight Site)

Lightweight site record used in list responses.

Field	Type	Description
id	integer	Site ID
name	string	Site name
client_id	number	Parent client ID
client_name	string	Parent client name
clientsite_name	string	Combined client+site name
inactive	boolean	Whether inactive
sla_id	integer	Assigned SLA
phonenumber	string	Phone number
colour	string	Display colour
timezone	string	Timezone
notes	string	Site notes
isstocklocation	boolean	Stock location flag
isinvoicesite	boolean	Invoice site flag
maincontact_id	integer	Main contact ID
maincontact_name	string	Main contact name
delivery_address_line1–_5	string	Delivery address
invoice_address_line1–_5	string	Invoice address
geocoord1 / geocoord2	number	Coordinates
itglue_id / client_itglue_id	string	IT Glue IDs
customfields	array	Custom fields
site_fields	array	Site fields
stockbins	array	Stock bins at this site
default_currency_code	integer	Currency code
client_to_invoice	integer	Client ID to invoice
client_to_invoice_recurring	integer	Client ID for recurring invoices

---