Equipment API

REST endpoints for equipment in ServFlo: 20 operations with parameters, request and response fields, permissions and curl examples.

Base URL: https://app.servflo.ai/api. Every call needs Authorization: Bearer sfk_… (Authentication); {organizationId} ($ORGANIZATION_ID in the examples) is your business's id.

Operation	Endpoint	Risk
A customer's sites (the properties they currently occupy)	`GET /organizations/{organizationId}/customers/{customerId}/sites`	`read`
Create a site (a property the customer owns)	`POST /organizations/{organizationId}/customers/{customerId}/sites`	`write`
Update a site	`PATCH /organizations/{organizationId}/sites/{siteId}`	`write`
A customer's equipment	`GET /organizations/{organizationId}/customers/{customerId}/assets`	`read`
Register equipment for a customer	`POST /organizations/{organizationId}/customers/{customerId}/assets`	`write`
All equipment	`GET /organizations/{organizationId}/assets`	`read`
Equipment at a property	`GET /organizations/{organizationId}/properties/{propertyId}/assets`	`read`
Register equipment at a property	`POST /organizations/{organizationId}/properties/{propertyId}/assets`	`write`
Equipment a job for this customer can be linked to	`GET /organizations/{organizationId}/customers/{customerId}/assets/options`	`read`
Get equipment with its type, property and owner	`GET /organizations/{organizationId}/assets/{assetId}`	`read`
Update equipment	`PATCH /organizations/{organizationId}/assets/{assetId}`	`write`
Equipment history, newest first	`GET /organizations/{organizationId}/assets/{assetId}/history`	`read`
Photos from jobs on this equipment	`GET /organizations/{organizationId}/assets/{assetId}/photos`	`read`
List equipment types	`GET /organizations/{organizationId}/equipment-types`	`read`
Add an equipment type	`POST /organizations/{organizationId}/equipment-types`	`write`
Get an equipment type	`GET /organizations/{organizationId}/equipment-types/{equipmentTypeId}`	`read`
Rename, change or archive an equipment type	`PATCH /organizations/{organizationId}/equipment-types/{equipmentTypeId}`	`write`
Add a trade's preset equipment types	`POST /organizations/{organizationId}/equipment-types/presets`	`write`
What equipment is called here	`GET /organizations/{organizationId}/equipment-labels`	`read`
Change what equipment is called	`PATCH /organizations/{organizationId}/equipment-labels`	`write`

A customer's sites (the properties they currently occupy)

GET /organizations/{organizationId}/customers/{customerId}/sites

The original API's sites: the properties the customer currently occupies. Read-only. Prefer GET /properties?customerId=… for the full property records.


Permission	`properties.read` (Owner, Admin, Dispatcher, Technician, Member)
Risk	`read`, OAuth scope `servflo.read`. Read: reads only.
MCP tool	`sites_list` (toolset `customers`)

Parameters

Name	In	Type	Required	Description
`customerId`	path	string	Yes

Example

curl "https://app.servflo.ai/api/organizations/$ORGANIZATION_ID/customers/{customerId}/sites" \
  -H "Authorization: Bearer $SERVFLO_API_KEY"

Response

200: the answer's fields

An array of objects:

Field	Type	Description
`id`	string	Property id.
`organizationId`	string
`name`	string or null
`address`	string or null
`address2`	string or null
`city`	string or null
`state`	string or null
`zip`	string or null
`country`	string or null
`propertyType`	enum	One of `RESIDENTIAL`, `COMMERCIAL`, `MULTI_FAMILY`, `INDUSTRIAL`.
`contactName`	string or null	Who to ask for on site.
`contactPhone`	string or null
`contactEmail`	string or null
`timezone`	string	IANA timezone of the property.
`accessInstructions`	string or null
`safetyNotes`	string or null
`gateCode`	string or null
`petsOnSite`	boolean
`petNotes`	string or null
`yearBuilt`	integer or null
`squareFeet`	integer or null
`tags`	array of string
`latitude`	number or null
`longitude`	number or null
`geocodeSource`	string or null	Where the coordinates came from: GEOCODER (the address), GEOCODER_STREET / GEOCODER_AREA (approximate: only its street or town is on the map; visit safety then searches the ZIP), MANUAL (pinned by hand).
`geocodedAt`	string (date-time) or null
`taxRate`	number or null	Tax rate in percent for work here; null = the business default.
`customFields`	any	Custom field values by key (definitions: GET /custom-fields).
`createdAt`	string (date-time)
`updatedAt`	string (date-time)

Create a site (a property the customer owns)

POST /organizations/{organizationId}/customers/{customerId}/sites

The original API's site create: creates a property and links the customer as its owner from today. Returns the site.


Permission	`properties.write` (Owner, Admin, Dispatcher)
Risk	`write`, OAuth scope `servflo.write`. Write: creates or changes records inside the business; nothing leaves it.
MCP tool	`sites_create` (toolset `customers`)

Parameters

Name	In	Type	Required	Description
`customerId`	path	string	Yes

Request body

Field	Type	Required	Description
`name`	string	Yes	Up to 500 characters.
`address`	string or null	No	Up to 500 characters.
`contactName`	string or null	No	Up to 500 characters.
`contactPhone`	string or null	No	Up to 500 characters.
`contactEmail`	empty string or string (email) or null	No
`timezone`	string	No	An IANA timezone, e.g. America/Chicago. Up to 100 characters.
`accessInstructions`	string or null	No	Up to 5000 characters.
`safetyNotes`	string or null	No	Up to 5000 characters.

Example

curl -X POST "https://app.servflo.ai/api/organizations/$ORGANIZATION_ID/customers/{customerId}/sites" \
  -H "Authorization: Bearer $SERVFLO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Dana Whitfield"}'

Response

201: the answer's fields

Field	Type	Description
`id`	string	Property id.
`organizationId`	string
`name`	string or null
`address`	string or null
`address2`	string or null
`city`	string or null
`state`	string or null
`zip`	string or null
`country`	string or null
`propertyType`	enum	One of `RESIDENTIAL`, `COMMERCIAL`, `MULTI_FAMILY`, `INDUSTRIAL`.
`contactName`	string or null	Who to ask for on site.
`contactPhone`	string or null
`contactEmail`	string or null
`timezone`	string	IANA timezone of the property.
`accessInstructions`	string or null
`safetyNotes`	string or null
`gateCode`	string or null
`petsOnSite`	boolean
`petNotes`	string or null
`yearBuilt`	integer or null
`squareFeet`	integer or null
`tags`	array of string
`latitude`	number or null
`longitude`	number or null
`geocodeSource`	string or null	Where the coordinates came from: GEOCODER (the address), GEOCODER_STREET / GEOCODER_AREA (approximate: only its street or town is on the map; visit safety then searches the ZIP), MANUAL (pinned by hand).
`geocodedAt`	string (date-time) or null
`taxRate`	number or null	Tax rate in percent for work here; null = the business default.
`customFields`	any	Custom field values by key (definitions: GET /custom-fields).
`createdAt`	string (date-time)
`updatedAt`	string (date-time)

Update a site

PATCH /organizations/{organizationId}/sites/{siteId}

The original API's site update: changes the property's fields sent. Same as PATCH /properties/{propertyId}.


Permission	`properties.write` (Owner, Admin, Dispatcher)
Risk	`write`, OAuth scope `servflo.write`. Write: creates or changes records inside the business; nothing leaves it.
MCP tool	`sites_update` (toolset `customers`)

Parameters

Name	In	Type	Required	Description
`siteId`	path	string	Yes

Request body

Field	Type	Required	Description
`name`	string	No	Up to 500 characters.
`address`	string or null	No	Up to 500 characters.
`contactName`	string or null	No	Up to 500 characters.
`contactPhone`	string or null	No	Up to 500 characters.
`contactEmail`	empty string or string (email) or null	No
`timezone`	string	No	An IANA timezone, e.g. America/Chicago. Up to 100 characters.
`accessInstructions`	string or null	No	Up to 5000 characters.
`safetyNotes`	string or null	No	Up to 5000 characters.

Example

curl -X PATCH "https://app.servflo.ai/api/organizations/$ORGANIZATION_ID/sites/{siteId}" \
  -H "Authorization: Bearer $SERVFLO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Dana Whitfield","address":"string","contactName":"string"}'

Response

200: the answer's fields

Field	Type	Description
`id`	string	Property id.
`organizationId`	string
`name`	string or null
`address`	string or null
`address2`	string or null
`city`	string or null
`state`	string or null
`zip`	string or null
`country`	string or null
`propertyType`	enum	One of `RESIDENTIAL`, `COMMERCIAL`, `MULTI_FAMILY`, `INDUSTRIAL`.
`contactName`	string or null	Who to ask for on site.
`contactPhone`	string or null
`contactEmail`	string or null
`timezone`	string	IANA timezone of the property.
`accessInstructions`	string or null
`safetyNotes`	string or null
`gateCode`	string or null
`petsOnSite`	boolean
`petNotes`	string or null
`yearBuilt`	integer or null
`squareFeet`	integer or null
`tags`	array of string
`latitude`	number or null
`longitude`	number or null
`geocodeSource`	string or null	Where the coordinates came from: GEOCODER (the address), GEOCODER_STREET / GEOCODER_AREA (approximate: only its street or town is on the map; visit safety then searches the ZIP), MANUAL (pinned by hand).
`geocodedAt`	string (date-time) or null
`taxRate`	number or null	Tax rate in percent for work here; null = the business default.
`customFields`	any	Custom field values by key (definitions: GET /custom-fields).
`createdAt`	string (date-time)
`updatedAt`	string (date-time)

A customer's equipment

GET /organizations/{organizationId}/customers/{customerId}/assets

The customer's own equipment (customer-owned: vehicles, boats …) and the equipment at the properties they currently occupy, filtered by text (name, serial, make, model), type, ownership and status, paged with a total. Read-only.


Permission	`properties.read` (Owner, Admin, Dispatcher, Technician, Member)
Risk	`read`, OAuth scope `servflo.read`. Read: reads only.
MCP tool	`assets_list` (toolset `customers`)

Parameters

Name	In	Type	Required	Description
`customerId`	path	string	Yes
`query`	query	string	No	Free-text search over the list's names, numbers and contact details. Up to 200 characters.
`equipmentTypeId`	query	string	No	Only this equipment type.
`ownership`	query	enum	No	Who owns it: PROPERTY (stays with the property when it changes hands; propertyId required) or CUSTOMER (a car, a boat: linkable to that customer's jobs at any address; propertyId optional, where it is kept). Unset: CUSTOMER when customerId is given or the type is customer-owned and a customer is known, else PROPERTY. One of `PROPERTY`, `CUSTOMER`.
`status`	query	enum	No	One of `IN_SERVICE`, `OUT_OF_SERVICE`, `RETIRED`.
`limit`	query	integer	No	Page size, 1–200. Default `50`.
`offset`	query	integer	No	Rows to skip; the answer's `total` counts every match. Default `0`.

Example

curl "https://app.servflo.ai/api/organizations/$ORGANIZATION_ID/customers/{customerId}/assets" \
  -H "Authorization: Bearer $SERVFLO_API_KEY"

Response

200: the answer's fields

Field	Type	Description
`items`	array of object
`items[].id`	string	Equipment (asset) id.
`items[].organizationId`	string
`items[].propertyId`	string or null	The property it belongs to (property-owned) or is kept at (customer-owned); null = a customer's, kept nowhere in particular.
`items[].customerId`	string or null	Set = customer-owned (a car, a boat): it goes wherever that customer's jobs are.
`items[].ownership`	enum	Who owns it: the property (stays on a transfer) or the customer. One of `PROPERTY`, `CUSTOMER`.
`items[].equipmentTypeId`	string or null	Its equipment type.
`items[].type`	object or null
`items[].type.id`	string
`items[].type.name`	string
`items[].type.icon`	string
`items[].type.customerOwned`	boolean
`items[].type.builtInFields`	array of string
`items[].type.builtInLabels`	any
`items[].type.archived`	boolean
`items[].name`	string
`items[].serialNumber`	string	Serial number or VIN; "" when not recorded. Unique per property and per owning customer.
`items[].manufacturer`	string or null
`items[].model`	string or null
`items[].status`	enum	RETIRED equipment is kept for history instead of being deleted. One of `IN_SERVICE`, `OUT_OF_SERVICE`, `RETIRED`.
`items[].installationDate`	string or null	YYYY-MM-DD
`items[].commissioningDate`	string or null	YYYY-MM-DD
`items[].warrantyStart`	string or null	YYYY-MM-DD
`items[].warrantyEnd`	string or null	YYYY-MM-DD
`items[].notes`	string or null
`items[].equipmentType`	string or null	Customer 360 lifespan key (AC, FURNACE …).
`items[].installYear`	integer or null
`items[].expectedLifespanYears`	integer or null
`items[].refrigerantType`	string or null
`items[].condition`	enum or null	One of `GOOD`, `FAIR`, `POOR`, `FAILED`.
`items[].customFields`	any	Custom field values by key (definitions: GET /custom-fields?entity=EQUIPMENT).
`items[].createdAt`	string (date-time)
`items[].updatedAt`	string (date-time)
`items[].property`	object or null	The property (all its fields on get and update); null for customer-owned equipment kept nowhere in particular.
`items[].property.id`	string	Property id.
`items[].property.name`	string or null
`items[].property.address`	string or null
`items[].property.city`	string or null
`items[].customer`	object or null	The owner: the owning customer, else the property's current primary customer; null when vacant.
`items[].customer.id`	string
`items[].customer.name`	string
`total`	integer	How many match the filters, across all pages.

Register equipment for a customer

POST /organizations/{organizationId}/customers/{customerId}/assets

Registers equipment for the customer: customer-owned (ownership CUSTOMER, e.g. a car; propertyId optional, where it is kept) or at one of the customer's current properties (ownership PROPERTY, propertyId or siteId required). Type from equipmentTypeId (GET /equipment-types), else matched from the name; its required custom fields must be given. Serial numbers are unique per property and per owning customer (409). Written to the equipment history. Returns the equipment.


Permission	`properties.write` (Owner, Admin, Dispatcher)
Risk	`write`, OAuth scope `servflo.write`. Write: creates or changes records inside the business; nothing leaves it.
MCP tool	`assets_create` (toolset `customers`)

Parameters

Name	In	Type	Required	Description
`customerId`	path	string	Yes

Request body

Field	Type	Required	Description
`propertyId`	string or null	No	The property it belongs to (property-owned) or is kept at (customer-owned; null clears it).
`siteId`	string or null	No	The original API's name for propertyId.
`ownership`	enum	No	Who owns it: PROPERTY (stays with the property when it changes hands; propertyId required) or CUSTOMER (a car, a boat: linkable to that customer's jobs at any address; propertyId optional, where it is kept). Unset: CUSTOMER when customerId is given or the type is customer-owned and a customer is known, else PROPERTY. One of `PROPERTY`, `CUSTOMER`.
`equipmentTypeId`	string or null	No	Its equipment type (GET /equipment-types). Unset on create: matched from the name, else Other.
`name`	string	Yes	Up to 500 characters.
`serialNumber`	string or null	No	Serial number or VIN; unique per property and per owning customer; blank = not recorded. Up to 500 characters.
`manufacturer`	string or null	No	Up to 500 characters.
`model`	string or null	No	Up to 500 characters.
`status`	enum	No	One of `IN_SERVICE`, `OUT_OF_SERVICE`, `RETIRED`.
`installationDate`	empty string or string or null	No
`commissioningDate`	empty string or string or null	No
`warrantyStart`	empty string or string or null	No
`warrantyEnd`	empty string or string or null	No
`notes`	string or null	No	Up to 5000 characters.
`equipmentType`	enum or null	No	Lifespan key for the replacement outlook; unset: the equipment type's, else read from the name. One of `AC`, `HEAT_PUMP`, `FURNACE`, `BOILER`, `MINI_SPLIT`, `AIR_HANDLER`, `PACKAGE_UNIT`, `WATER_HEATER`, `TANKLESS_WATER_HEATER`, `THERMOSTAT`, `HUMIDIFIER`, `AIR_PURIFIER`, `WATER_SOFTENER`, `SUMP_PUMP`, `WELL_PUMP`, `SEPTIC_PUMP`, `BACKFLOW_PREVENTER`, `ELECTRICAL_PANEL`, `GENERATOR`, `EV_CHARGER`, `GARAGE_DOOR_OPENER`, `POOL_PUMP`, `POOL_HEATER`, `REFRIGERATION`, `ICE_MACHINE`, `OTHER`.
`installYear`	integer or null	No	The install year when only the year is known (data plate); installationDate wins when set. 1900–2100.
`expectedLifespanYears`	integer or null	No	This unit's expected lifespan in years, overriding the organization's lifespan table. 1–100.
`refrigerantType`	string or null	No	e.g. R-22, R-410A, R-454B. R-22 raises the replacement likelihood. Up to 50 characters.
`condition`	enum or null	No	Condition as last assessed. One of `GOOD`, `FAIR`, `POOR`, `FAILED`.
`customFields`	object	No	Values of the fields for every type and of its own type's (GET /custom-fields?entity=EQUIPMENT&equipmentTypeId=…). Required ones are checked on create and when the type changes.

Example

curl -X POST "https://app.servflo.ai/api/organizations/$ORGANIZATION_ID/customers/{customerId}/assets" \
  -H "Authorization: Bearer $SERVFLO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Dana Whitfield"}'

Response

201: the answer's fields

Field	Type	Description
`id`	string	Equipment (asset) id.
`organizationId`	string
`propertyId`	string or null	The property it belongs to (property-owned) or is kept at (customer-owned); null = a customer's, kept nowhere in particular.
`customerId`	string or null	Set = customer-owned (a car, a boat): it goes wherever that customer's jobs are.
`ownership`	enum	Who owns it: the property (stays on a transfer) or the customer. One of `PROPERTY`, `CUSTOMER`.
`equipmentTypeId`	string or null	Its equipment type.
`type`	object or null
`type.id`	string
`type.name`	string
`type.icon`	string
`type.customerOwned`	boolean
`type.builtInFields`	array of string
`type.builtInLabels`	any
`type.archived`	boolean
`name`	string
`serialNumber`	string	Serial number or VIN; "" when not recorded. Unique per property and per owning customer.
`manufacturer`	string or null
`model`	string or null
`status`	enum	RETIRED equipment is kept for history instead of being deleted. One of `IN_SERVICE`, `OUT_OF_SERVICE`, `RETIRED`.
`installationDate`	string or null	YYYY-MM-DD
`commissioningDate`	string or null	YYYY-MM-DD
`warrantyStart`	string or null	YYYY-MM-DD
`warrantyEnd`	string or null	YYYY-MM-DD
`notes`	string or null
`equipmentType`	string or null	Customer 360 lifespan key (AC, FURNACE …).
`installYear`	integer or null
`expectedLifespanYears`	integer or null
`refrigerantType`	string or null
`condition`	enum or null	One of `GOOD`, `FAIR`, `POOR`, `FAILED`.
`customFields`	any	Custom field values by key (definitions: GET /custom-fields?entity=EQUIPMENT).
`createdAt`	string (date-time)
`updatedAt`	string (date-time)
`property`	object or null	The property (all its fields on get and update); null for customer-owned equipment kept nowhere in particular.
`property.id`	string	Property id.
`property.name`	string or null
`property.address`	string or null
`property.city`	string or null
`customer`	object or null	The owner: the owning customer, else the property's current primary customer; null when vacant.
`customer.id`	string
`customer.name`	string

All equipment

GET /organizations/{organizationId}/assets

Every piece of equipment in the business (a technician: only that of their jobs), with type, property and owner, filtered by text (name, serial, make, model), type, ownership and status, paged with a total. Read-only.


Permission	`properties.read` (Owner, Admin, Dispatcher, Technician, Member)
Risk	`read`, OAuth scope `servflo.read`. Read: reads only.
MCP tool	`assets_listAll` (toolset `customers`)

Parameters

Name	In	Type	Required	Description
`query`	query	string	No	Free-text search over the list's names, numbers and contact details. Up to 200 characters.
`equipmentTypeId`	query	string	No	Only this equipment type.
`ownership`	query	enum	No	Who owns it: PROPERTY (stays with the property when it changes hands; propertyId required) or CUSTOMER (a car, a boat: linkable to that customer's jobs at any address; propertyId optional, where it is kept). Unset: CUSTOMER when customerId is given or the type is customer-owned and a customer is known, else PROPERTY. One of `PROPERTY`, `CUSTOMER`.
`status`	query	enum	No	One of `IN_SERVICE`, `OUT_OF_SERVICE`, `RETIRED`.
`limit`	query	integer	No	Page size, 1–200. Default `50`.
`offset`	query	integer	No	Rows to skip; the answer's `total` counts every match. Default `0`.

Example

curl "https://app.servflo.ai/api/organizations/$ORGANIZATION_ID/assets" \
  -H "Authorization: Bearer $SERVFLO_API_KEY"

Response

200: the answer's fields

Field	Type	Description
`items`	array of object
`items[].id`	string	Equipment (asset) id.
`items[].organizationId`	string
`items[].propertyId`	string or null	The property it belongs to (property-owned) or is kept at (customer-owned); null = a customer's, kept nowhere in particular.
`items[].customerId`	string or null	Set = customer-owned (a car, a boat): it goes wherever that customer's jobs are.
`items[].ownership`	enum	Who owns it: the property (stays on a transfer) or the customer. One of `PROPERTY`, `CUSTOMER`.
`items[].equipmentTypeId`	string or null	Its equipment type.
`items[].type`	object or null
`items[].type.id`	string
`items[].type.name`	string
`items[].type.icon`	string
`items[].type.customerOwned`	boolean
`items[].type.builtInFields`	array of string
`items[].type.builtInLabels`	any
`items[].type.archived`	boolean
`items[].name`	string
`items[].serialNumber`	string	Serial number or VIN; "" when not recorded. Unique per property and per owning customer.
`items[].manufacturer`	string or null
`items[].model`	string or null
`items[].status`	enum	RETIRED equipment is kept for history instead of being deleted. One of `IN_SERVICE`, `OUT_OF_SERVICE`, `RETIRED`.
`items[].installationDate`	string or null	YYYY-MM-DD
`items[].commissioningDate`	string or null	YYYY-MM-DD
`items[].warrantyStart`	string or null	YYYY-MM-DD
`items[].warrantyEnd`	string or null	YYYY-MM-DD
`items[].notes`	string or null
`items[].equipmentType`	string or null	Customer 360 lifespan key (AC, FURNACE …).
`items[].installYear`	integer or null
`items[].expectedLifespanYears`	integer or null
`items[].refrigerantType`	string or null
`items[].condition`	enum or null	One of `GOOD`, `FAIR`, `POOR`, `FAILED`.
`items[].customFields`	any	Custom field values by key (definitions: GET /custom-fields?entity=EQUIPMENT).
`items[].createdAt`	string (date-time)
`items[].updatedAt`	string (date-time)
`items[].property`	object or null	The property (all its fields on get and update); null for customer-owned equipment kept nowhere in particular.
`items[].property.id`	string	Property id.
`items[].property.name`	string or null
`items[].property.address`	string or null
`items[].property.city`	string or null
`items[].customer`	object or null	The owner: the owning customer, else the property's current primary customer; null when vacant.
`items[].customer.id`	string
`items[].customer.name`	string
`total`	integer	How many match the filters, across all pages.

Equipment at a property

GET /organizations/{organizationId}/properties/{propertyId}/assets

Equipment registered at the property (its own, and customers' equipment kept there), filtered by text, type, ownership and status, paged with a total. Read-only. 404 for an unknown property.


Permission	`properties.read` (Owner, Admin, Dispatcher, Technician, Member)
Risk	`read`, OAuth scope `servflo.read`. Read: reads only.
MCP tool	`assets_listForProperty` (toolset `customers`)

Parameters

Name	In	Type	Required	Description
`propertyId`	path	string	Yes
`query`	query	string	No	Free-text search over the list's names, numbers and contact details. Up to 200 characters.
`equipmentTypeId`	query	string	No	Only this equipment type.
`ownership`	query	enum	No	Who owns it: PROPERTY (stays with the property when it changes hands; propertyId required) or CUSTOMER (a car, a boat: linkable to that customer's jobs at any address; propertyId optional, where it is kept). Unset: CUSTOMER when customerId is given or the type is customer-owned and a customer is known, else PROPERTY. One of `PROPERTY`, `CUSTOMER`.
`status`	query	enum	No	One of `IN_SERVICE`, `OUT_OF_SERVICE`, `RETIRED`.
`limit`	query	integer	No	Page size, 1–200. Default `50`.
`offset`	query	integer	No	Rows to skip; the answer's `total` counts every match. Default `0`.

Example

curl "https://app.servflo.ai/api/organizations/$ORGANIZATION_ID/properties/{propertyId}/assets" \
  -H "Authorization: Bearer $SERVFLO_API_KEY"

Response

200: the answer's fields

Field	Type	Description
`items`	array of object
`items[].id`	string	Equipment (asset) id.
`items[].organizationId`	string
`items[].propertyId`	string or null	The property it belongs to (property-owned) or is kept at (customer-owned); null = a customer's, kept nowhere in particular.
`items[].customerId`	string or null	Set = customer-owned (a car, a boat): it goes wherever that customer's jobs are.
`items[].ownership`	enum	Who owns it: the property (stays on a transfer) or the customer. One of `PROPERTY`, `CUSTOMER`.
`items[].equipmentTypeId`	string or null	Its equipment type.
`items[].type`	object or null
`items[].type.id`	string
`items[].type.name`	string
`items[].type.icon`	string
`items[].type.customerOwned`	boolean
`items[].type.builtInFields`	array of string
`items[].type.builtInLabels`	any
`items[].type.archived`	boolean
`items[].name`	string
`items[].serialNumber`	string	Serial number or VIN; "" when not recorded. Unique per property and per owning customer.
`items[].manufacturer`	string or null
`items[].model`	string or null
`items[].status`	enum	RETIRED equipment is kept for history instead of being deleted. One of `IN_SERVICE`, `OUT_OF_SERVICE`, `RETIRED`.
`items[].installationDate`	string or null	YYYY-MM-DD
`items[].commissioningDate`	string or null	YYYY-MM-DD
`items[].warrantyStart`	string or null	YYYY-MM-DD
`items[].warrantyEnd`	string or null	YYYY-MM-DD
`items[].notes`	string or null
`items[].equipmentType`	string or null	Customer 360 lifespan key (AC, FURNACE …).
`items[].installYear`	integer or null
`items[].expectedLifespanYears`	integer or null
`items[].refrigerantType`	string or null
`items[].condition`	enum or null	One of `GOOD`, `FAIR`, `POOR`, `FAILED`.
`items[].customFields`	any	Custom field values by key (definitions: GET /custom-fields?entity=EQUIPMENT).
`items[].createdAt`	string (date-time)
`items[].updatedAt`	string (date-time)
`items[].property`	object or null	The property (all its fields on get and update); null for customer-owned equipment kept nowhere in particular.
`items[].property.id`	string	Property id.
`items[].property.name`	string or null
`items[].property.address`	string or null
`items[].property.city`	string or null
`items[].customer`	object or null	The owner: the owning customer, else the property's current primary customer; null when vacant.
`items[].customer.id`	string
`items[].customer.name`	string
`total`	integer	How many match the filters, across all pages.

Register equipment at a property

POST /organizations/{organizationId}/properties/{propertyId}/assets

Registers equipment at the property: owned by the property, or, with customerId (ownership CUSTOMER), a customer's own equipment kept there. Type from equipmentTypeId, else matched from the name. Serial numbers are unique per property and per owning customer (409). Written to the equipment history. Returns the equipment.


Permission	`properties.write` (Owner, Admin, Dispatcher)
Risk	`write`, OAuth scope `servflo.write`. Write: creates or changes records inside the business; nothing leaves it.
MCP tool	`assets_createForProperty` (toolset `customers`)

Parameters

Name	In	Type	Required	Description
`propertyId`	path	string	Yes

Request body

Field	Type	Required	Description
`customerId`	string or null	No	The owning customer for customer-owned equipment (on an update, null makes it property-owned).
`ownership`	enum	No	Who owns it: PROPERTY (stays with the property when it changes hands; propertyId required) or CUSTOMER (a car, a boat: linkable to that customer's jobs at any address; propertyId optional, where it is kept). Unset: CUSTOMER when customerId is given or the type is customer-owned and a customer is known, else PROPERTY. One of `PROPERTY`, `CUSTOMER`.
`equipmentTypeId`	string or null	No	Its equipment type (GET /equipment-types). Unset on create: matched from the name, else Other.
`name`	string	Yes	Up to 500 characters.
`serialNumber`	string or null	No	Serial number or VIN; unique per property and per owning customer; blank = not recorded. Up to 500 characters.
`manufacturer`	string or null	No	Up to 500 characters.
`model`	string or null	No	Up to 500 characters.
`status`	enum	No	One of `IN_SERVICE`, `OUT_OF_SERVICE`, `RETIRED`.
`installationDate`	empty string or string or null	No
`commissioningDate`	empty string or string or null	No
`warrantyStart`	empty string or string or null	No
`warrantyEnd`	empty string or string or null	No
`notes`	string or null	No	Up to 5000 characters.
`equipmentType`	enum or null	No	Lifespan key for the replacement outlook; unset: the equipment type's, else read from the name. One of `AC`, `HEAT_PUMP`, `FURNACE`, `BOILER`, `MINI_SPLIT`, `AIR_HANDLER`, `PACKAGE_UNIT`, `WATER_HEATER`, `TANKLESS_WATER_HEATER`, `THERMOSTAT`, `HUMIDIFIER`, `AIR_PURIFIER`, `WATER_SOFTENER`, `SUMP_PUMP`, `WELL_PUMP`, `SEPTIC_PUMP`, `BACKFLOW_PREVENTER`, `ELECTRICAL_PANEL`, `GENERATOR`, `EV_CHARGER`, `GARAGE_DOOR_OPENER`, `POOL_PUMP`, `POOL_HEATER`, `REFRIGERATION`, `ICE_MACHINE`, `OTHER`.
`installYear`	integer or null	No	The install year when only the year is known (data plate); installationDate wins when set. 1900–2100.
`expectedLifespanYears`	integer or null	No	This unit's expected lifespan in years, overriding the organization's lifespan table. 1–100.
`refrigerantType`	string or null	No	e.g. R-22, R-410A, R-454B. R-22 raises the replacement likelihood. Up to 50 characters.
`condition`	enum or null	No	Condition as last assessed. One of `GOOD`, `FAIR`, `POOR`, `FAILED`.
`customFields`	object	No	Values of the fields for every type and of its own type's (GET /custom-fields?entity=EQUIPMENT&equipmentTypeId=…). Required ones are checked on create and when the type changes.

Example

curl -X POST "https://app.servflo.ai/api/organizations/$ORGANIZATION_ID/properties/{propertyId}/assets" \
  -H "Authorization: Bearer $SERVFLO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Dana Whitfield"}'

Response

201: the answer's fields

Field	Type	Description
`id`	string	Equipment (asset) id.
`organizationId`	string
`propertyId`	string or null	The property it belongs to (property-owned) or is kept at (customer-owned); null = a customer's, kept nowhere in particular.
`customerId`	string or null	Set = customer-owned (a car, a boat): it goes wherever that customer's jobs are.
`ownership`	enum	Who owns it: the property (stays on a transfer) or the customer. One of `PROPERTY`, `CUSTOMER`.
`equipmentTypeId`	string or null	Its equipment type.
`type`	object or null
`type.id`	string
`type.name`	string
`type.icon`	string
`type.customerOwned`	boolean
`type.builtInFields`	array of string
`type.builtInLabels`	any
`type.archived`	boolean
`name`	string
`serialNumber`	string	Serial number or VIN; "" when not recorded. Unique per property and per owning customer.
`manufacturer`	string or null
`model`	string or null
`status`	enum	RETIRED equipment is kept for history instead of being deleted. One of `IN_SERVICE`, `OUT_OF_SERVICE`, `RETIRED`.
`installationDate`	string or null	YYYY-MM-DD
`commissioningDate`	string or null	YYYY-MM-DD
`warrantyStart`	string or null	YYYY-MM-DD
`warrantyEnd`	string or null	YYYY-MM-DD
`notes`	string or null
`equipmentType`	string or null	Customer 360 lifespan key (AC, FURNACE …).
`installYear`	integer or null
`expectedLifespanYears`	integer or null
`refrigerantType`	string or null
`condition`	enum or null	One of `GOOD`, `FAIR`, `POOR`, `FAILED`.
`customFields`	any	Custom field values by key (definitions: GET /custom-fields?entity=EQUIPMENT).
`createdAt`	string (date-time)
`updatedAt`	string (date-time)
`property`	object or null	The property (all its fields on get and update); null for customer-owned equipment kept nowhere in particular.
`property.id`	string	Property id.
`property.name`	string or null
`property.address`	string or null
`property.city`	string or null
`customer`	object or null	The owner: the owning customer, else the property's current primary customer; null when vacant.
`customer.id`	string
`customer.name`	string

Equipment a job for this customer can be linked to

GET /organizations/{organizationId}/customers/{customerId}/assets/options

Id, name, type and ownership of the equipment a job for this customer may link (not retired): their own equipment, linkable at any address, and the equipment at their current properties. For the job form's picker. Read-only.


Permission	`properties.read` (Owner, Admin, Dispatcher, Technician, Member)
Risk	`read`, OAuth scope `servflo.read`. Read: reads only.
MCP tool	`assets_options` (toolset `customers`)

Parameters

Name	In	Type	Required	Description
`customerId`	path	string	Yes

Example

curl "https://app.servflo.ai/api/organizations/$ORGANIZATION_ID/customers/{customerId}/assets/options" \
  -H "Authorization: Bearer $SERVFLO_API_KEY"

Response

200: the answer's fields

An array of objects:

Field	Type	Description
`id`	string	Equipment id (a job's `assetId`).
`name`	string
`serialNumber`	string
`ownership`	enum	One of `PROPERTY`, `CUSTOMER`.
`type`	object or null
`type.id`	string
`type.name`	string
`type.icon`	string
`type.customerOwned`	boolean
`type.builtInFields`	array of string
`type.builtInLabels`	any
`type.archived`	boolean
`property`	object or null
`property.id`	string	Property id.
`property.name`	string or null
`property.address`	string or null
`property.city`	string or null

Get equipment with its type, property and owner

GET /organizations/{organizationId}/assets/{assetId}

One piece of equipment with its type, its property (if any) and the customer it belongs to (the owning customer, else the property's current primary customer). Read-only.


Permission	`properties.read` (Owner, Admin, Dispatcher, Technician, Member)
Risk	`read`, OAuth scope `servflo.read`. Read: reads only.
MCP tool	`assets_get` (toolset `customers`)

Parameters

Name	In	Type	Required	Description
`assetId`	path	string	Yes

Example

curl "https://app.servflo.ai/api/organizations/$ORGANIZATION_ID/assets/{assetId}" \
  -H "Authorization: Bearer $SERVFLO_API_KEY"

Response

200: the answer's fields

Field	Type	Description
`id`	string	Equipment (asset) id.
`organizationId`	string
`propertyId`	string or null	The property it belongs to (property-owned) or is kept at (customer-owned); null = a customer's, kept nowhere in particular.
`customerId`	string or null	Set = customer-owned (a car, a boat): it goes wherever that customer's jobs are.
`ownership`	enum	Who owns it: the property (stays on a transfer) or the customer. One of `PROPERTY`, `CUSTOMER`.
`equipmentTypeId`	string or null	Its equipment type.
`type`	object or null
`type.id`	string
`type.name`	string
`type.icon`	string
`type.customerOwned`	boolean
`type.builtInFields`	array of string
`type.builtInLabels`	any
`type.archived`	boolean
`name`	string
`serialNumber`	string	Serial number or VIN; "" when not recorded. Unique per property and per owning customer.
`manufacturer`	string or null
`model`	string or null
`status`	enum	RETIRED equipment is kept for history instead of being deleted. One of `IN_SERVICE`, `OUT_OF_SERVICE`, `RETIRED`.
`installationDate`	string or null	YYYY-MM-DD
`commissioningDate`	string or null	YYYY-MM-DD
`warrantyStart`	string or null	YYYY-MM-DD
`warrantyEnd`	string or null	YYYY-MM-DD
`notes`	string or null
`equipmentType`	string or null	Customer 360 lifespan key (AC, FURNACE …).
`installYear`	integer or null
`expectedLifespanYears`	integer or null
`refrigerantType`	string or null
`condition`	enum or null	One of `GOOD`, `FAIR`, `POOR`, `FAILED`.
`customFields`	any	Custom field values by key (definitions: GET /custom-fields?entity=EQUIPMENT).
`createdAt`	string (date-time)
`updatedAt`	string (date-time)
`property`	object or null
`property.id`	string	Property id.
`property.organizationId`	string
`property.name`	string or null
`property.address`	string or null
`property.address2`	string or null
`property.city`	string or null
`property.state`	string or null
`property.zip`	string or null
`property.country`	string or null
`property.propertyType`	enum	One of `RESIDENTIAL`, `COMMERCIAL`, `MULTI_FAMILY`, `INDUSTRIAL`.
`property.contactName`	string or null	Who to ask for on site.
`property.contactPhone`	string or null
`property.contactEmail`	string or null
`property.timezone`	string	IANA timezone of the property.
`property.accessInstructions`	string or null
`property.safetyNotes`	string or null
`property.gateCode`	string or null
`property.petsOnSite`	boolean
`property.petNotes`	string or null
`property.yearBuilt`	integer or null
`property.squareFeet`	integer or null
`property.tags`	array of string
`property.latitude`	number or null
`property.longitude`	number or null
`property.geocodeSource`	string or null	Where the coordinates came from: GEOCODER (the address), GEOCODER_STREET / GEOCODER_AREA (approximate: only its street or town is on the map; visit safety then searches the ZIP), MANUAL (pinned by hand).
`property.geocodedAt`	string (date-time) or null
`property.taxRate`	number or null	Tax rate in percent for work here; null = the business default.
`property.customFields`	any	Custom field values by key (definitions: GET /custom-fields).
`property.createdAt`	string (date-time)
`property.updatedAt`	string (date-time)
`customer`	object or null	The owner: the owning customer, else the property's current primary customer; null when vacant.
`customer.id`	string
`customer.name`	string
`site`	object or null	The property again, under the original API's name.
`site.id`	string	Property id.
`site.organizationId`	string
`site.name`	string or null
`site.address`	string or null
`site.address2`	string or null
`site.city`	string or null
`site.state`	string or null
`site.zip`	string or null
`site.country`	string or null
`site.propertyType`	enum	One of `RESIDENTIAL`, `COMMERCIAL`, `MULTI_FAMILY`, `INDUSTRIAL`.
`site.contactName`	string or null	Who to ask for on site.
`site.contactPhone`	string or null
`site.contactEmail`	string or null
`site.timezone`	string	IANA timezone of the property.
`site.accessInstructions`	string or null
`site.safetyNotes`	string or null
`site.gateCode`	string or null
`site.petsOnSite`	boolean
`site.petNotes`	string or null
`site.yearBuilt`	integer or null
`site.squareFeet`	integer or null
`site.tags`	array of string
`site.latitude`	number or null
`site.longitude`	number or null
`site.geocodeSource`	string or null	Where the coordinates came from: GEOCODER (the address), GEOCODER_STREET / GEOCODER_AREA (approximate: only its street or town is on the map; visit safety then searches the ZIP), MANUAL (pinned by hand).
`site.geocodedAt`	string (date-time) or null
`site.taxRate`	number or null	Tax rate in percent for work here; null = the business default.
`site.customFields`	any	Custom field values by key (definitions: GET /custom-fields).
`site.createdAt`	string (date-time)
`site.updatedAt`	string (date-time)

Update equipment

PATCH /organizations/{organizationId}/assets/{assetId}

Changes the fields sent. Moving it to another property, changing its owner (ownership / customerId), its type and its status (RETIRED instead of deleting) are recorded in the equipment history. Custom field values merge into the saved ones; a new type's required fields are checked. Returns the equipment.


Permission	`properties.write` (Owner, Admin, Dispatcher)
Risk	`write`, OAuth scope `servflo.write`. Write: creates or changes records inside the business; nothing leaves it.
MCP tool	`assets_update` (toolset `customers`)

Parameters

Name	In	Type	Required	Description
`assetId`	path	string	Yes

Request body

Field	Type	Required	Description
`propertyId`	string or null	No	The property it belongs to (property-owned) or is kept at (customer-owned; null clears it).
`siteId`	string or null	No	The original API's name for propertyId.
`customerId`	string or null	No	The owning customer for customer-owned equipment (on an update, null makes it property-owned).
`ownership`	enum	No	Who owns it: PROPERTY (stays with the property when it changes hands; propertyId required) or CUSTOMER (a car, a boat: linkable to that customer's jobs at any address; propertyId optional, where it is kept). Unset: CUSTOMER when customerId is given or the type is customer-owned and a customer is known, else PROPERTY. One of `PROPERTY`, `CUSTOMER`.
`equipmentTypeId`	string or null	No	Its equipment type (GET /equipment-types). Unset on create: matched from the name, else Other.
`name`	string	No	Up to 500 characters.
`serialNumber`	string or null	No	Serial number or VIN; unique per property and per owning customer; blank = not recorded. Up to 500 characters.
`manufacturer`	string or null	No	Up to 500 characters.
`model`	string or null	No	Up to 500 characters.
`status`	enum	No	One of `IN_SERVICE`, `OUT_OF_SERVICE`, `RETIRED`.
`installationDate`	empty string or string or null	No
`commissioningDate`	empty string or string or null	No
`warrantyStart`	empty string or string or null	No
`warrantyEnd`	empty string or string or null	No
`notes`	string or null	No	Up to 5000 characters.
`equipmentType`	enum or null	No	Lifespan key for the replacement outlook; unset: the equipment type's, else read from the name. One of `AC`, `HEAT_PUMP`, `FURNACE`, `BOILER`, `MINI_SPLIT`, `AIR_HANDLER`, `PACKAGE_UNIT`, `WATER_HEATER`, `TANKLESS_WATER_HEATER`, `THERMOSTAT`, `HUMIDIFIER`, `AIR_PURIFIER`, `WATER_SOFTENER`, `SUMP_PUMP`, `WELL_PUMP`, `SEPTIC_PUMP`, `BACKFLOW_PREVENTER`, `ELECTRICAL_PANEL`, `GENERATOR`, `EV_CHARGER`, `GARAGE_DOOR_OPENER`, `POOL_PUMP`, `POOL_HEATER`, `REFRIGERATION`, `ICE_MACHINE`, `OTHER`.
`installYear`	integer or null	No	The install year when only the year is known (data plate); installationDate wins when set. 1900–2100.
`expectedLifespanYears`	integer or null	No	This unit's expected lifespan in years, overriding the organization's lifespan table. 1–100.
`refrigerantType`	string or null	No	e.g. R-22, R-410A, R-454B. R-22 raises the replacement likelihood. Up to 50 characters.
`condition`	enum or null	No	Condition as last assessed. One of `GOOD`, `FAIR`, `POOR`, `FAILED`.
`customFields`	object	No	Values of the fields for every type and of its own type's (GET /custom-fields?entity=EQUIPMENT&equipmentTypeId=…). Required ones are checked on create and when the type changes.

Example

curl -X PATCH "https://app.servflo.ai/api/organizations/$ORGANIZATION_ID/assets/{assetId}" \
  -H "Authorization: Bearer $SERVFLO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"propertyId":"property_id","siteId":"site_id","customerId":"customer_id"}'

Response

200: the answer's fields

Field	Type	Description
`id`	string	Equipment (asset) id.
`organizationId`	string
`propertyId`	string or null	The property it belongs to (property-owned) or is kept at (customer-owned); null = a customer's, kept nowhere in particular.
`customerId`	string or null	Set = customer-owned (a car, a boat): it goes wherever that customer's jobs are.
`ownership`	enum	Who owns it: the property (stays on a transfer) or the customer. One of `PROPERTY`, `CUSTOMER`.
`equipmentTypeId`	string or null	Its equipment type.
`type`	object or null
`type.id`	string
`type.name`	string
`type.icon`	string
`type.customerOwned`	boolean
`type.builtInFields`	array of string
`type.builtInLabels`	any
`type.archived`	boolean
`name`	string
`serialNumber`	string	Serial number or VIN; "" when not recorded. Unique per property and per owning customer.
`manufacturer`	string or null
`model`	string or null
`status`	enum	RETIRED equipment is kept for history instead of being deleted. One of `IN_SERVICE`, `OUT_OF_SERVICE`, `RETIRED`.
`installationDate`	string or null	YYYY-MM-DD
`commissioningDate`	string or null	YYYY-MM-DD
`warrantyStart`	string or null	YYYY-MM-DD
`warrantyEnd`	string or null	YYYY-MM-DD
`notes`	string or null
`equipmentType`	string or null	Customer 360 lifespan key (AC, FURNACE …).
`installYear`	integer or null
`expectedLifespanYears`	integer or null
`refrigerantType`	string or null
`condition`	enum or null	One of `GOOD`, `FAIR`, `POOR`, `FAILED`.
`customFields`	any	Custom field values by key (definitions: GET /custom-fields?entity=EQUIPMENT).
`createdAt`	string (date-time)
`updatedAt`	string (date-time)
`property`	object or null
`property.id`	string	Property id.
`property.organizationId`	string
`property.name`	string or null
`property.address`	string or null
`property.address2`	string or null
`property.city`	string or null
`property.state`	string or null
`property.zip`	string or null
`property.country`	string or null
`property.propertyType`	enum	One of `RESIDENTIAL`, `COMMERCIAL`, `MULTI_FAMILY`, `INDUSTRIAL`.
`property.contactName`	string or null	Who to ask for on site.
`property.contactPhone`	string or null
`property.contactEmail`	string or null
`property.timezone`	string	IANA timezone of the property.
`property.accessInstructions`	string or null
`property.safetyNotes`	string or null
`property.gateCode`	string or null
`property.petsOnSite`	boolean
`property.petNotes`	string or null
`property.yearBuilt`	integer or null
`property.squareFeet`	integer or null
`property.tags`	array of string
`property.latitude`	number or null
`property.longitude`	number or null
`property.geocodeSource`	string or null	Where the coordinates came from: GEOCODER (the address), GEOCODER_STREET / GEOCODER_AREA (approximate: only its street or town is on the map; visit safety then searches the ZIP), MANUAL (pinned by hand).
`property.geocodedAt`	string (date-time) or null
`property.taxRate`	number or null	Tax rate in percent for work here; null = the business default.
`property.customFields`	any	Custom field values by key (definitions: GET /custom-fields).
`property.createdAt`	string (date-time)
`property.updatedAt`	string (date-time)
`customer`	object or null	The owner: the owning customer, else the property's current primary customer; null when vacant.
`customer.id`	string
`customer.name`	string

Equipment history, newest first

GET /organizations/{organizationId}/assets/{assetId}/history

The equipment's history: registered, moved, status changes, jobs linked/updated/unlinked/deleted and job notes; paged with a total. Read-only.


Permission	`properties.read` (Owner, Admin, Dispatcher, Technician, Member)
Risk	`read`, OAuth scope `servflo.read`. Read: reads only.
MCP tool	`assets_history` (toolset `customers`)

Parameters

Name	In	Type	Required	Description
`assetId`	path	string	Yes
`limit`	query	integer	No	Page size, 1–200. Default `50`.
`offset`	query	integer	No	Rows to skip; the answer's `total` counts every match. Default `0`.

Example

curl "https://app.servflo.ai/api/organizations/$ORGANIZATION_ID/assets/{assetId}/history" \
  -H "Authorization: Bearer $SERVFLO_API_KEY"

Response

200: the answer's fields

Field	Type	Description
`items`	array of object
`items[].id`	string
`items[].assetId`	string
`items[].jobId`	string or null
`items[].summary`	string	What happened (registered, moved, status changed, job …).
`items[].details`	string
`items[].createdAt`	string (date-time)
`items[].availableJobId`	string or null	`jobId` while that job still exists.
`total`	integer	How many match the filters, across all pages.

Photos from jobs on this equipment

GET /organizations/{organizationId}/assets/{assetId}/photos

Before, after, general and issue photos taken on the jobs linked to this equipment, newest first (up to 60), each with its job and 10-minute view and download URLs. Read-only. A technician gets 404 for equipment they have no job on.


Permission	`properties.read` (Owner, Admin, Dispatcher, Technician, Member)
Risk	`read`, OAuth scope `servflo.read`. Read: reads only.
MCP tool	`assets_photos` (toolset `customers`)

Parameters

Name	In	Type	Required	Description
`assetId`	path	string	Yes

Example

curl "https://app.servflo.ai/api/organizations/$ORGANIZATION_ID/assets/{assetId}/photos" \
  -H "Authorization: Bearer $SERVFLO_API_KEY"

Response

200: the answer's fields

An array of objects:

Field	Type	Description
`id`	string
`jobId`	string or null
`tag`	enum or null	One of `BEFORE`, `AFTER`, `GENERAL`, `ISSUE`, `SIGNATURE`.
`fileName`	string
`contentType`	string
`sizeBytes`	integer
`uploadedAt`	string (date-time) or null
`createdAt`	string (date-time)
`url`	string	View URL, valid for 10 minutes.
`downloadUrl`	string	Download URL, valid for 10 minutes.
`job`	object or null
`job.id`	string
`job.identifier`	string	JOB-n
`job.scheduledDate`	string

List equipment types

GET /organizations/{organizationId}/equipment-types

The business's kinds of equipment (seeded once from its trade, e.g. Furnace / Air conditioner for HVAC, Car / Boat for detailing), each with its icon, built-in columns, default ownership and its own custom fields; archived ones with includeArchived. Needed before registering equipment (equipmentTypeId). Read-only.


Permission	`properties.read` (Owner, Admin, Dispatcher, Technician, Member)
Risk	`read`, OAuth scope `servflo.read`. Read: reads only.
MCP tool	`equipmentTypes_list` (toolset `customers`)

Parameters

Name	In	Type	Required	Description
`includeArchived`	query	boolean	No

Example

curl "https://app.servflo.ai/api/organizations/$ORGANIZATION_ID/equipment-types" \
  -H "Authorization: Bearer $SERVFLO_API_KEY"

Response

200: the answer's fields

An array of objects:

Field	Type	Description
`id`	string	Equipment type id (an asset's `equipmentTypeId`).
`organizationId`	string
`name`	string	e.g. Furnace, Car, Pool. The owner's to rename.
`icon`	string	Icon key.
`presetKey`	string or null	The trade preset it was seeded from (e.g. hvac.furnace); null = added by the owner.
`lifespanKey`	string or null	Customer 360 lifespan key new equipment of this type gets (AC, FURNACE …).
`customerOwned`	boolean	New equipment of this type belongs to the customer by default (vehicles, boats).
`builtInFields`	array of string	Built-in columns shown for this type: serialNumber, manufacturer, model, installationDate, warranty, condition, refrigerantType, lifespan.
`builtInLabels`	any	Labels for built-in columns, e.g. { "serialNumber": "VIN", "manufacturer": "Make" }.
`sortOrder`	integer
`archived`	boolean
`customFields`	array of object	The type's own fields (entity EQUIPMENT); fields for every type are listed separately.
`customFields[].id`	string	Custom field id.
`customFields[].organizationId`	string
`customFields[].entity`	enum	The record type the field is on. One of `CUSTOMER`, `PROPERTY`, `EQUIPMENT`, `JOB`, `VISIT`, `QUOTE`, `INVOICE`, `TECHNICIAN`.
`customFields[].key`	string	The key its values are stored under in the record's `customFields`; fixed. Two equipment types may share a key.
`customFields[].label`	string
`customFields[].type`	enum	One of `TEXT`, `TEXTAREA`, `NUMBER`, `DATE`, `CHECKBOX`, `SELECT`, `MULTI_SELECT`, `URL`, `EMAIL`, `PHONE`.
`customFields[].options`	array of string	The choices of a SELECT or MULTI_SELECT field.
`customFields[].required`	boolean
`customFields[].sortOrder`	integer
`customFields[].archived`	boolean
`customFields[].equipmentTypeId`	string or null	EQUIPMENT only: the equipment type the field belongs to; null = every type.
`customFields[].sensitive`	boolean	Sensitive (gate codes, medical notes): values read as •••• without customFields.sensitive.read; POST /custom-fields/reveal for one.
`customFields[].visibleToCustomer`	boolean	Shown to the customer: printed on quote/invoice documents, their emails and pages, and in the customer portal.
`customFields[].createdAt`	string (date-time)
`_count`	object
`_count.assets`	integer
`createdAt`	string (date-time)
`updatedAt`	string (date-time)

Add an equipment type

POST /organizations/{organizationId}/equipment-types

Adds a kind of equipment (e.g. Generator, Jet ski). Add its own fields after with POST /custom-fields (entity EQUIPMENT, equipmentTypeId). Returns the type.


Permission	`settings.manage` (Owner, Admin)
Risk	`write`, OAuth scope `servflo.write`. Write: creates or changes records inside the business; nothing leaves it.
MCP tool	`equipmentTypes_create` (toolset `customers`)

Request body

Field	Type	Required	Description
`name`	string	Yes	e.g. Furnace, Car, Pool. Up to 80 characters.
`icon`	enum	No	Icon shown beside the type. One of `wrench`, `fan`, `flame`, `snowflake`, `thermometer`, `droplet`, `droplets`, `waves`, `zap`, `plug`, `battery`, `sun`, `car`, `truck`, `bus`, `ship`, `bike`, `caravan`, `home`, `door`, `bug`, `tree`, `sprout`, `sparkles`, `spray`, `lock`, `refrigerator`, `washing-machine`, `box`, `cog`.
`customerOwned`	boolean	No	New equipment of this type belongs to the customer (vehicles, boats).
`builtInFields`	array of enum	No	Built-in columns shown for the type (the rest are hidden): serialNumber, manufacturer, model, installationDate, warranty, condition, refrigerantType, lifespan. Up to 8 items.
`builtInLabels`	object	No	Own labels for built-in columns, e.g. { "serialNumber": "VIN", "manufacturer": "Make" }.
`lifespanKey`	enum or null	No	Customer 360 lifespan key new equipment of this type gets (AC, FURNACE …). One of `AC`, `HEAT_PUMP`, `FURNACE`, `BOILER`, `MINI_SPLIT`, `AIR_HANDLER`, `PACKAGE_UNIT`, `WATER_HEATER`, `TANKLESS_WATER_HEATER`, `THERMOSTAT`, `HUMIDIFIER`, `AIR_PURIFIER`, `WATER_SOFTENER`, `SUMP_PUMP`, `WELL_PUMP`, `SEPTIC_PUMP`, `BACKFLOW_PREVENTER`, `ELECTRICAL_PANEL`, `GENERATOR`, `EV_CHARGER`, `GARAGE_DOOR_OPENER`, `POOL_PUMP`, `POOL_HEATER`, `REFRIGERATION`, `ICE_MACHINE`, `OTHER`.
`sortOrder`	integer	No

Example

curl -X POST "https://app.servflo.ai/api/organizations/$ORGANIZATION_ID/equipment-types" \
  -H "Authorization: Bearer $SERVFLO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Dana Whitfield"}'

Response

201: the answer's fields

Field	Type	Description
`id`	string	Equipment type id (an asset's `equipmentTypeId`).
`organizationId`	string
`name`	string	e.g. Furnace, Car, Pool. The owner's to rename.
`icon`	string	Icon key.
`presetKey`	string or null	The trade preset it was seeded from (e.g. hvac.furnace); null = added by the owner.
`lifespanKey`	string or null	Customer 360 lifespan key new equipment of this type gets (AC, FURNACE …).
`customerOwned`	boolean	New equipment of this type belongs to the customer by default (vehicles, boats).
`builtInFields`	array of string	Built-in columns shown for this type: serialNumber, manufacturer, model, installationDate, warranty, condition, refrigerantType, lifespan.
`builtInLabels`	any	Labels for built-in columns, e.g. { "serialNumber": "VIN", "manufacturer": "Make" }.
`sortOrder`	integer
`archived`	boolean
`customFields`	array of object	The type's own fields (entity EQUIPMENT); fields for every type are listed separately.
`customFields[].id`	string	Custom field id.
`customFields[].organizationId`	string
`customFields[].entity`	enum	The record type the field is on. One of `CUSTOMER`, `PROPERTY`, `EQUIPMENT`, `JOB`, `VISIT`, `QUOTE`, `INVOICE`, `TECHNICIAN`.
`customFields[].key`	string	The key its values are stored under in the record's `customFields`; fixed. Two equipment types may share a key.
`customFields[].label`	string
`customFields[].type`	enum	One of `TEXT`, `TEXTAREA`, `NUMBER`, `DATE`, `CHECKBOX`, `SELECT`, `MULTI_SELECT`, `URL`, `EMAIL`, `PHONE`.
`customFields[].options`	array of string	The choices of a SELECT or MULTI_SELECT field.
`customFields[].required`	boolean
`customFields[].sortOrder`	integer
`customFields[].archived`	boolean
`customFields[].equipmentTypeId`	string or null	EQUIPMENT only: the equipment type the field belongs to; null = every type.
`customFields[].sensitive`	boolean	Sensitive (gate codes, medical notes): values read as •••• without customFields.sensitive.read; POST /custom-fields/reveal for one.
`customFields[].visibleToCustomer`	boolean	Shown to the customer: printed on quote/invoice documents, their emails and pages, and in the customer portal.
`customFields[].createdAt`	string (date-time)
`_count`	object
`_count.assets`	integer
`createdAt`	string (date-time)
`updatedAt`	string (date-time)

Get an equipment type

GET /organizations/{organizationId}/equipment-types/{equipmentTypeId}

One equipment type with its own custom fields and equipment count. Read-only.


Permission	`properties.read` (Owner, Admin, Dispatcher, Technician, Member)
Risk	`read`, OAuth scope `servflo.read`. Read: reads only.
MCP tool	`equipmentTypes_get` (toolset `customers`)

Parameters

Name	In	Type	Required	Description
`equipmentTypeId`	path	string	Yes

Example

curl "https://app.servflo.ai/api/organizations/$ORGANIZATION_ID/equipment-types/{equipmentTypeId}" \
  -H "Authorization: Bearer $SERVFLO_API_KEY"

Response

200: the answer's fields

Field	Type	Description
`id`	string	Equipment type id (an asset's `equipmentTypeId`).
`organizationId`	string
`name`	string	e.g. Furnace, Car, Pool. The owner's to rename.
`icon`	string	Icon key.
`presetKey`	string or null	The trade preset it was seeded from (e.g. hvac.furnace); null = added by the owner.
`lifespanKey`	string or null	Customer 360 lifespan key new equipment of this type gets (AC, FURNACE …).
`customerOwned`	boolean	New equipment of this type belongs to the customer by default (vehicles, boats).
`builtInFields`	array of string	Built-in columns shown for this type: serialNumber, manufacturer, model, installationDate, warranty, condition, refrigerantType, lifespan.
`builtInLabels`	any	Labels for built-in columns, e.g. { "serialNumber": "VIN", "manufacturer": "Make" }.
`sortOrder`	integer
`archived`	boolean
`customFields`	array of object	The type's own fields (entity EQUIPMENT); fields for every type are listed separately.
`customFields[].id`	string	Custom field id.
`customFields[].organizationId`	string
`customFields[].entity`	enum	The record type the field is on. One of `CUSTOMER`, `PROPERTY`, `EQUIPMENT`, `JOB`, `VISIT`, `QUOTE`, `INVOICE`, `TECHNICIAN`.
`customFields[].key`	string	The key its values are stored under in the record's `customFields`; fixed. Two equipment types may share a key.
`customFields[].label`	string
`customFields[].type`	enum	One of `TEXT`, `TEXTAREA`, `NUMBER`, `DATE`, `CHECKBOX`, `SELECT`, `MULTI_SELECT`, `URL`, `EMAIL`, `PHONE`.
`customFields[].options`	array of string	The choices of a SELECT or MULTI_SELECT field.
`customFields[].required`	boolean
`customFields[].sortOrder`	integer
`customFields[].archived`	boolean
`customFields[].equipmentTypeId`	string or null	EQUIPMENT only: the equipment type the field belongs to; null = every type.
`customFields[].sensitive`	boolean	Sensitive (gate codes, medical notes): values read as •••• without customFields.sensitive.read; POST /custom-fields/reveal for one.
`customFields[].visibleToCustomer`	boolean	Shown to the customer: printed on quote/invoice documents, their emails and pages, and in the customer portal.
`customFields[].createdAt`	string (date-time)
`_count`	object
`_count.assets`	integer
`createdAt`	string (date-time)
`updatedAt`	string (date-time)

Rename, change or archive an equipment type

PATCH /organizations/{organizationId}/equipment-types/{equipmentTypeId}

Changes the fields sent. archived: true removes it from pickers (its equipment keeps it, nothing is deleted); false brings it back. Returns the type.


Permission	`settings.manage` (Owner, Admin)
Risk	`write`, OAuth scope `servflo.write`. Write: creates or changes records inside the business; nothing leaves it.
MCP tool	`equipmentTypes_update` (toolset `customers`)

Parameters

Name	In	Type	Required	Description
`equipmentTypeId`	path	string	Yes

Request body

Field	Type	Required	Description
`name`	string	No	e.g. Furnace, Car, Pool. Up to 80 characters.
`icon`	enum	No	Icon shown beside the type. One of `wrench`, `fan`, `flame`, `snowflake`, `thermometer`, `droplet`, `droplets`, `waves`, `zap`, `plug`, `battery`, `sun`, `car`, `truck`, `bus`, `ship`, `bike`, `caravan`, `home`, `door`, `bug`, `tree`, `sprout`, `sparkles`, `spray`, `lock`, `refrigerator`, `washing-machine`, `box`, `cog`.
`customerOwned`	boolean	No
`builtInFields`	array of enum	No	Built-in columns shown for the type (the rest are hidden): serialNumber, manufacturer, model, installationDate, warranty, condition, refrigerantType, lifespan. Up to 8 items.
`builtInLabels`	object	No	Own labels for built-in columns, e.g. { "serialNumber": "VIN", "manufacturer": "Make" }.
`lifespanKey`	enum or null	No	Customer 360 lifespan key new equipment of this type gets (AC, FURNACE …). One of `AC`, `HEAT_PUMP`, `FURNACE`, `BOILER`, `MINI_SPLIT`, `AIR_HANDLER`, `PACKAGE_UNIT`, `WATER_HEATER`, `TANKLESS_WATER_HEATER`, `THERMOSTAT`, `HUMIDIFIER`, `AIR_PURIFIER`, `WATER_SOFTENER`, `SUMP_PUMP`, `WELL_PUMP`, `SEPTIC_PUMP`, `BACKFLOW_PREVENTER`, `ELECTRICAL_PANEL`, `GENERATOR`, `EV_CHARGER`, `GARAGE_DOOR_OPENER`, `POOL_PUMP`, `POOL_HEATER`, `REFRIGERATION`, `ICE_MACHINE`, `OTHER`.
`sortOrder`	integer	No
`archived`	boolean	No

Example

curl -X PATCH "https://app.servflo.ai/api/organizations/$ORGANIZATION_ID/equipment-types/{equipmentTypeId}" \
  -H "Authorization: Bearer $SERVFLO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Dana Whitfield","icon":"wrench","customerOwned":true}'

Response

200: the answer's fields

Field	Type	Description
`id`	string	Equipment type id (an asset's `equipmentTypeId`).
`organizationId`	string
`name`	string	e.g. Furnace, Car, Pool. The owner's to rename.
`icon`	string	Icon key.
`presetKey`	string or null	The trade preset it was seeded from (e.g. hvac.furnace); null = added by the owner.
`lifespanKey`	string or null	Customer 360 lifespan key new equipment of this type gets (AC, FURNACE …).
`customerOwned`	boolean	New equipment of this type belongs to the customer by default (vehicles, boats).
`builtInFields`	array of string	Built-in columns shown for this type: serialNumber, manufacturer, model, installationDate, warranty, condition, refrigerantType, lifespan.
`builtInLabels`	any	Labels for built-in columns, e.g. { "serialNumber": "VIN", "manufacturer": "Make" }.
`sortOrder`	integer
`archived`	boolean
`customFields`	array of object	The type's own fields (entity EQUIPMENT); fields for every type are listed separately.
`customFields[].id`	string	Custom field id.
`customFields[].organizationId`	string
`customFields[].entity`	enum	The record type the field is on. One of `CUSTOMER`, `PROPERTY`, `EQUIPMENT`, `JOB`, `VISIT`, `QUOTE`, `INVOICE`, `TECHNICIAN`.
`customFields[].key`	string	The key its values are stored under in the record's `customFields`; fixed. Two equipment types may share a key.
`customFields[].label`	string
`customFields[].type`	enum	One of `TEXT`, `TEXTAREA`, `NUMBER`, `DATE`, `CHECKBOX`, `SELECT`, `MULTI_SELECT`, `URL`, `EMAIL`, `PHONE`.
`customFields[].options`	array of string	The choices of a SELECT or MULTI_SELECT field.
`customFields[].required`	boolean
`customFields[].sortOrder`	integer
`customFields[].archived`	boolean
`customFields[].equipmentTypeId`	string or null	EQUIPMENT only: the equipment type the field belongs to; null = every type.
`customFields[].sensitive`	boolean	Sensitive (gate codes, medical notes): values read as •••• without customFields.sensitive.read; POST /custom-fields/reveal for one.
`customFields[].visibleToCustomer`	boolean	Shown to the customer: printed on quote/invoice documents, their emails and pages, and in the customer portal.
`customFields[].createdAt`	string (date-time)
`_count`	object
`_count.assets`	integer
`createdAt`	string (date-time)
`updatedAt`	string (date-time)

Add a trade's preset equipment types

POST /organizations/{organizationId}/equipment-types/presets

Adds the preset types (with their fields) of a trade the business does not have yet, e.g. pool-spa for a plumber who also services pools. Presets already added, renamed or archived are left alone. Returns how many were added and every type.


Permission	`settings.manage` (Owner, Admin)
Risk	`write`, OAuth scope `servflo.write`. Write: creates or changes records inside the business; nothing leaves it.
MCP tool	`equipmentTypes_addPresets` (toolset `customers`)

Request body

Field	Type	Required	Description
`trade`	enum	Yes	Trade key (hvac, plumbing, pool-spa, car-detailing … or other). One of `hvac`, `plumbing`, `electrical`, `roofing`, `lawn-care`, `landscaping`, `tree-care`, `pest-control`, `house-cleaning`, `carpet-cleaning`, `window-cleaning`, `pressure-washing`, `pool-spa`, `painting`, `handyman`, `garage-doors`, `appliance-repair`, `locksmith`, `junk-removal`, `moving`, `flooring`, `remodeling`, `solar`, `septic-drain`, `chimney-fireplace`, `irrigation`, `car-detailing`, `other`.

Example

curl -X POST "https://app.servflo.ai/api/organizations/$ORGANIZATION_ID/equipment-types/presets" \
  -H "Authorization: Bearer $SERVFLO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"trade":"hvac"}'

Response

200: the answer's fields

Field	Type	Description
`added`	integer
`types`	array of object
`types[].id`	string	Equipment type id (an asset's `equipmentTypeId`).
`types[].organizationId`	string
`types[].name`	string	e.g. Furnace, Car, Pool. The owner's to rename.
`types[].icon`	string	Icon key.
`types[].presetKey`	string or null	The trade preset it was seeded from (e.g. hvac.furnace); null = added by the owner.
`types[].lifespanKey`	string or null	Customer 360 lifespan key new equipment of this type gets (AC, FURNACE …).
`types[].customerOwned`	boolean	New equipment of this type belongs to the customer by default (vehicles, boats).
`types[].builtInFields`	array of string	Built-in columns shown for this type: serialNumber, manufacturer, model, installationDate, warranty, condition, refrigerantType, lifespan.
`types[].builtInLabels`	any	Labels for built-in columns, e.g. { "serialNumber": "VIN", "manufacturer": "Make" }.
`types[].sortOrder`	integer
`types[].archived`	boolean
`types[].customFields`	array of object	The type's own fields (entity EQUIPMENT); fields for every type are listed separately.
`types[].customFields[].id`	string	Custom field id.
`types[].customFields[].organizationId`	string
`types[].customFields[].entity`	enum	The record type the field is on. One of `CUSTOMER`, `PROPERTY`, `EQUIPMENT`, `JOB`, `VISIT`, `QUOTE`, `INVOICE`, `TECHNICIAN`.
`types[].customFields[].key`	string	The key its values are stored under in the record's `customFields`; fixed. Two equipment types may share a key.
`types[].customFields[].label`	string
`types[].customFields[].type`	enum	One of `TEXT`, `TEXTAREA`, `NUMBER`, `DATE`, `CHECKBOX`, `SELECT`, `MULTI_SELECT`, `URL`, `EMAIL`, `PHONE`.
`types[].customFields[].options`	array of string	The choices of a SELECT or MULTI_SELECT field.
`types[].customFields[].required`	boolean
`types[].customFields[].sortOrder`	integer
`types[].customFields[].archived`	boolean
`types[].customFields[].equipmentTypeId`	string or null	EQUIPMENT only: the equipment type the field belongs to; null = every type.
`types[].customFields[].sensitive`	boolean	Sensitive (gate codes, medical notes): values read as •••• without customFields.sensitive.read; POST /custom-fields/reveal for one.
`types[].customFields[].visibleToCustomer`	boolean	Shown to the customer: printed on quote/invoice documents, their emails and pages, and in the customer portal.
`types[].customFields[].createdAt`	string (date-time)
`types[]._count`	object
`types[]._count.assets`	integer
`types[].createdAt`	string (date-time)
`types[].updatedAt`	string (date-time)

What equipment is called here

GET /organizations/{organizationId}/equipment-labels

The business's word for equipment, singular and plural (e.g. Vehicle / Vehicles for a detailer, Unit / Units for HVAC): the owner's own when set, else the trade's default. Use it when talking to the business about its equipment. Read-only.


Permission	`properties.read` (Owner, Admin, Dispatcher, Technician, Member)
Risk	`read`, OAuth scope `servflo.read`. Read: reads only.
MCP tool	`equipmentTypes_labels` (toolset `customers`)

Example

curl "https://app.servflo.ai/api/organizations/$ORGANIZATION_ID/equipment-labels" \
  -H "Authorization: Bearer $SERVFLO_API_KEY"

Response

200: the answer's fields

Field	Type	Description
`singular`	string	What one piece of equipment is called here, e.g. Vehicle.
`plural`	string	e.g. Vehicles.
`custom`	boolean	The owner set their own wording (else the trade's default).
`tradeDefault`	object
`tradeDefault.singular`	string
`tradeDefault.plural`	string

Change what equipment is called

PATCH /organizations/{organizationId}/equipment-labels

Sets the word used for equipment across the app, the portal and emails (singular and plural, 1–40 characters each); null goes back to the trade's default. Returns the wording in use.


Permission	`settings.manage` (Owner, Admin)
Risk	`write`, OAuth scope `servflo.write`. Write: creates or changes records inside the business; nothing leaves it.
MCP tool	`equipmentTypes_updateLabels` (toolset `customers`)

Request body

Field	Type	Required	Description
`singular`	string or null	No	e.g. Vehicle; null = the trade's default. Up to 40 characters.
`plural`	string or null	No	e.g. Vehicles; null = the trade's default. Up to 40 characters.

Example

curl -X PATCH "https://app.servflo.ai/api/organizations/$ORGANIZATION_ID/equipment-labels" \
  -H "Authorization: Bearer $SERVFLO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"singular":"string","plural":"string"}'

Response

200: the answer's fields

Field	Type	Description
`singular`	string	What one piece of equipment is called here, e.g. Vehicle.
`plural`	string	e.g. Vehicles.
`custom`	boolean	The owner set their own wording (else the trade's default).
`tradeDefault`	object
`tradeDefault.singular`	string
`tradeDefault.plural`	string

On this page