List item types
GET
/service-item-types
const url = 'https://example.com/service-item-types';const options = { method: 'GET', headers: {cookie: '__Host-bottle.session_token=<__Host-bottle.session_token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://example.com/service-item-types \ --cookie __Host-bottle.session_token=<__Host-bottle.session_token>The kinds of equipment this business services, such as Regulator or Manifold, each with the extra details recorded on it, in the order they are shown.
Authorizations
Section titled “Authorizations”Responses
Section titled “Responses”The item types
Media typeapplication/json
object
items
required
Array<object>
object
id
required
UUID v7
string format: uuid
name
required
string
fields
required
Array<object>
object
id
required
UUID v7
string format: uuid
name
required
string
valueType
required
string
required
required
boolean
unique
required
boolean
pattern
required
string | null
hint
required
string | null
itemCount
required
integer
Example
{ "items": [ { "id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f", "name": "Regulator", "fields": [ { "id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f", "name": "Serial number", "valueType": "text" } ] } ]}Not signed in
Media typeapplication/json
object
error
required
string
message
required
string
Example
{ "error": "not_found", "message": "Customer not found"}Not an owner or admin, missing scope, or the plan does not open Equipment servicing
Media typeapplication/json
object
error
required
string
message
required
string
Example
{ "error": "not_found", "message": "Customer not found"}Not found, or Equipment servicing is not available to this business
Media typeapplication/json
object
error
required
string
message
required
string
Example
{ "error": "not_found", "message": "Customer not found"}Equipment servicing is switched off, other equipment already has that detail, or the cylinder already has servicing set up
Media typeapplication/json
object
error
required
string
message
required
string
Example
{ "error": "not_found", "message": "Customer not found"}Validation failed
Media typeapplication/json
object
error
required
string
message
required
string
issues
required
Array<object>
object
path
required
string
message
required
string
Example
{ "error": "validation", "issues": [ { "path": "email", "message": "Invalid email" } ]}