From your ERP to the app
Organise and send work
Intervention types, forms, customers, technicians, cases, appointments, missions, checklists, documents, quotes, recurring work and knowledge base.
API · Gestione pratiche
Collega il tuo software alla gestione pratiche SellViaApp.
Crea e segui interventi, assegna tecnici e gestisci messaggi, documenti, preventivi, approvazioni, checklist, ricorrenze e tempi dal tuo sistema.
URL della base
https://api.sellviaapp.com/Required headers
Developer supportapi@sellviaapp.com
X-API-Key + BearerAvvio rapido
Authenticate, choose a route, test.
Get the X-API-Key and generate the Bearer in Dashboard → API. Enter them below, then use “Test · Generate” on an endpoint to obtain the response and cURL, PHP 8 or JavaScript code.
Credentials incompleteEnter the X-API-Key and Bearer token to prepare a test.
Credentials remain in memory for this page only. For a customer-related operation, add customer_id.
Keep in mindHTTPS + JSON · keep both credentials server-side · never send tokens to support.
ERP ↔ SellViaApp
Your ERP can drive the complete mobile experience.
The API is not limited to retrieving cases. Your software can configure the module, supply the data used by the app, assign technicians and retrieve actions completed in the field or by customers.
From the app to your ERP
Retrieve real activity
Customer requests, statuses, progress, messages, photos, documents, completed steps, time entries, quote decisions, approvals and signatures.
Controlled synchronisation
Keep one business workflow
Your ERP stores the identifiers returned by SellViaApp, retrieves cases and related data, then applies only relevant changes to your system.
- 1ConnectUse the X-API-Key and Bearer generated in Dashboard → API.
- 2ConfigureCreate the required types, forms, technicians, checklists and technical content.
- 3OperateCreate or update cases, then assign interventions.
- 4SynchroniseRetrieve cases, messages, documents, time entries and approvals needed by your ERP.
Developer tipStart with Cases and lifecycle, then add the business categories your ERP actually needs. Every endpoint can be tested and generates ready-to-copy code.
Punti di fine
Cases and lifecycle
Create, search, retrieve and update a case: status, priority, progress, appointments, assignment and technician mission.
5 routes ⌄
Punti di fine
Cases and lifecycle
Create, search, retrieve and update a case: status, priority, progress, appointments, assignment and technician mission.
/case/list
Chiave + Cuscinetto
List the signed-in customer cases; a supplier token can list every case.
Input
URL queryAvailable parameters
NomeTipo diRequirementDesignazione delle merci
page
Integer
Optional
Numero di pagina, a partire da 1.
per_page
Integer
Optional
Number of results per page.
customer_id
Integer
Optional
Required only with an integration token when the operation targets a specific customer.
status
stringa
Optional
Filter by status code.
type_id
Integer
Optional
Filter by intervention type.
priority
enumera
Optional
low | normal | high | urgent
q
stringa
Optional
Supplier search by reference, title, description or assignee.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxxxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"items": [],
"pagination": {
"page": 1,
"per_page": 25,
"total": 0,
"last_page": 1
}
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/case/detail
Chiave + Cuscinetto
Retrieve a case with timeline, messages, documents and detailed quotes. The private mission is returned only to the assigned technician and supplier.
Input
URL queryAvailable parameters
NomeTipo diRequirementDesignazione delle merci
id
Integer
Obbligatorio
Case identifier.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxxxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/case/create
Chiave + Cuscinetto
Create a service request linked to the customer.
Input
Corpo JSONAvailable parameters
NomeTipo diRequirementDesignazione delle merci
customer_id
Integer
Optional
Required only with a supplier token.
type_id
Integer
Optional
Active intervention type.
title
stringa
Obbligatorio
Short request title.
description
stringa
Obbligatorio
Problem or request description.
status
stringa
Optional
Supplier only; defaults to new.
priority
enumera
Optional
low | normal | high | urgent
progress
Integer
Optional
0 - 100
address
stringa
Optional
Service address.
appointment_start
datetime
Optional
YYYY-MM-DD HH:MM:SS
appointment_end
datetime
Optional
YYYY-MM-DD HH:MM:SS
assigned_to
stringa
Optional
Assigned person or team.
technician_id
Integer
Optional
Assigned technician; supplier only.
custom_fields
object
Optional
Values indexed by custom field ID or key.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxxxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/case/update
Chiave + Cuscinetto
Update customer, type, status, priority, progress, appointment and assignment.
Input
Corpo JSONAvailable parameters
NomeTipo diRequirementDesignazione delle merci
id
Integer
Obbligatorio
Case identifier.
customer_id
Integer
Optional
Linked customer; 0 removes the link.
type_id
Integer
Optional
Type; 0 removes the type.
title
stringa
Optional
Case title.
description
stringa
Optional
Detailed description.
status
stringa
Optional
Code returned by case/status/list.
priority
enumera
Optional
low | normal | high | urgent
progress
Integer
Optional
0 - 100
address
stringa
Optional
Service address.
appointment_start
datetime
Optional
Empty to clear the date.
appointment_end
datetime
Optional
Empty to clear the date.
assigned_to
stringa
Optional
Assigned person or team.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxxxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/case/status/list
Chiave + Cuscinetto
List workflow statuses and their translated labels.
Input
URL queryAvailable parameters
No business parameter is expected. Send only the indicated authentication headers.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxxxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"items": [],
"pagination": {
"page": 1,
"per_page": 25,
"total": 0,
"last_page": 1
}
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}Punti di fine
Types and forms
Let the ERP manage intervention types and custom fields requested in the mobile app.
8 routes ⌄
Punti di fine
Types and forms
Let the ERP manage intervention types and custom fields requested in the mobile app.
/case/type/list
Chiave + Cuscinetto
List available intervention types.
Input
URL queryAvailable parameters
NomeTipo diRequirementDesignazione delle merci
include_inactive
boolean
Optional
Supplier only; includes hidden types.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxxxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"items": [],
"pagination": {
"page": 1,
"per_page": 25,
"total": 0,
"last_page": 1
}
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/case/type/add
Chiave + Cuscinetto
Create an intervention type.
Input
Corpo JSONAvailable parameters
NomeTipo diRequirementDesignazione delle merci
name
stringa
Obbligatorio
Type name.
description
stringa
Optional
Maximum 2,000 characters.
sort_order
Integer
Optional
Display order.
active
boolean
Optional
Active by default.
Output
Possible results
201Resource created
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxxxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/case/type/update
Chiave + Cuscinetto
Edit, reorder or hide an intervention type.
Input
Corpo JSONAvailable parameters
NomeTipo diRequirementDesignazione delle merci
id
Integer
Obbligatorio
Type identifier.
name
stringa
Obbligatorio
Type name.
description
stringa
Optional
Description.
sort_order
Integer
Optional
Display order.
active
boolean
Optional
Type availability.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxxxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/case/type/delete
Chiave + Cuscinetto
Delete an unused type or archive a linked type.
Input
Corpo JSONAvailable parameters
NomeTipo diRequirementDesignazione delle merci
id
Integer
Obbligatorio
A type in use will be archived.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxxxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/case/form/list
Chiave + Cuscinetto
List custom service-request fields.
Input
URL queryAvailable parameters
NomeTipo diRequirementDesignazione delle merci
type_id
Integer
Optional
Limit to global fields and the selected type.
include_inactive
boolean
Optional
Supplier only.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxxxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"items": [],
"pagination": {
"page": 1,
"per_page": 25,
"total": 0,
"last_page": 1
}
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/case/form/add
Chiave + Cuscinetto
Add information to request from customers.
Input
Corpo JSONAvailable parameters
NomeTipo diRequirementDesignazione delle merci
type_id
Integer
Optional
0 or omitted for every type.
label_fr
stringa
Obbligatorio
French label.
label_en
stringa
Optional
English label.
field_type
enumera
Obbligatorio
text | textarea | select | boolean | date | number
options
array
Optional
Required for select.
required
boolean
Optional
Required answer.
sort_order
Integer
Optional
Display order.
Output
Possible results
201Resource created
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxxxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/case/form/update
Chiave + Cuscinetto
Update a custom request field.
Input
Corpo JSONAvailable parameters
NomeTipo diRequirementDesignazione delle merci
id
Integer
Obbligatorio
Field identifier.
type_id
Integer
Optional
Linked type or 0.
label_fr
stringa
Obbligatorio
French label.
label_en
stringa
Optional
English label.
field_type
enumera
Obbligatorio
text | textarea | select | boolean | date | number
options
array
Optional
Menu options.
required
boolean
Optional
Required answer.
active
boolean
Optional
Visible field.
sort_order
Integer
Optional
Order.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxxxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/case/form/delete
Chiave + Cuscinetto
Delete or archive a custom request field.
Input
Corpo JSONAvailable parameters
NomeTipo diRequirementDesignazione delle merci
id
Integer
Obbligatorio
Field identifier.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxxxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}Punti di fine
Technicians and assignments
Synchronise field teams, skills and roles, then assign every intervention to the right technician.
5 routes ⌄
Punti di fine
Technicians and assignments
Synchronise field teams, skills and roles, then assign every intervention to the right technician.
/case/technician/list
Chiave + Cuscinetto
List technicians separately with job, skills, availability and workload.
Input
URL queryAvailable parameters
No business parameter is expected. Send only the indicated authentication headers.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxxxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"items": [],
"pagination": {
"page": 1,
"per_page": 25,
"total": 0,
"last_page": 1
}
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/case/technician/detail
Chiave + Cuscinetto
Retrieve a technician’s complete professional record.
Input
URL queryAvailable parameters
NomeTipo diRequirementDesignazione delle merci
technician_id
Integer
Obbligatorio
Technician identifier.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxxxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/case/technician/profile
Chiave + Cuscinetto
Create or update a technician account’s professional profile.
Input
Corpo JSONAvailable parameters
NomeTipo diRequirementDesignazione delle merci
technician_id
Integer
Obbligatorio
Mobile account to configure as technician.
employee_code
stringa
Optional
Employee or internal code.
job_title
stringa
Optional
Technician job title.
specialties
stringa
Optional
Field specialities.
skills
stringa
Optional
Skills and certifications.
service_area
stringa
Optional
Service area.
availability_notes
stringa
Optional
Usual availability.
emergency_available
boolean
Optional
Available for emergencies.
internal_notes
stringa
Optional
Internal notes hidden in the app.
profile_color
stringa
Optional
#RRGGBB
active
boolean
Optional
Active technician.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxxxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/case/technician/role
Chiave + Cuscinetto
Assign the Customer or Technician role to a mobile account.
Input
Corpo JSONAvailable parameters
NomeTipo diRequirementDesignazione delle merci
customer_id
Integer
Obbligatorio
Mobile account.
role
enumera
Obbligatorio
client | technician
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxxxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/case/technician/update
Chiave + Cuscinetto
Allow the assigned technician to update status and progress.
Input
Corpo JSONAvailable parameters
NomeTipo diRequirementDesignazione delle merci
case_id
Integer
Obbligatorio
Service assigned to the signed-in technician.
status
enumera
Obbligatorio
planned | in_progress | waiting_customer | completed
progress
Integer
Optional
0 - 100
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxxxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}Punti di fine
Missions and checklists
Prepare procedures, retrieve applied steps and record field completion.
7 routes ⌄
Punti di fine
Missions and checklists
Prepare procedures, retrieve applied steps and record field completion.
/case/checklist/list
Chiave + Cuscinetto
Retrieve the checklist and progress for an authorised case.
Input
URL queryAvailable parameters
NomeTipo diRequirementDesignazione delle merci
case_id
Integer
Obbligatorio
Case authorised for the signed-in account.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxxxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"items": [],
"pagination": {
"page": 1,
"per_page": 25,
"total": 0,
"last_page": 1
}
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/case/mission/update
Chiave + Cuscinetto
Set the private mission visible only to the assigned technician.
Input
Corpo JSONAvailable parameters
NomeTipo diRequirementDesignazione delle merci
case_id
Integer
Obbligatorio
Case whose mission is being set.
mission_note
stringa
Optional
Private technician instruction, maximum 10,000 characters. An empty value clears the mission.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxxxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/case/checklist/item/update
Chiave + Cuscinetto
Complete or reopen a step; assigned technician or supplier only.
Input
Corpo JSONAvailable parameters
NomeTipo diRequirementDesignazione delle merci
case_id
Integer
Obbligatorio
Case assigned to the technician.
item_id
Integer
Obbligatorio
Checklist step.
completed
boolean
Obbligatorio
Complete or reopen the step.
note
stringa
Optional
Optional field note.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxxxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/case/checklist/template/list
Chiave + Cuscinetto
List checklist templates and their steps.
Input
URL queryAvailable parameters
No business parameter is expected. Send only the indicated authentication headers.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxxxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"items": [],
"pagination": {
"page": 1,
"per_page": 25,
"total": 0,
"last_page": 1
}
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/case/checklist/template/add
Chiave + Cuscinetto
Create a global checklist or one linked to an intervention type.
Input
Corpo JSONAvailable parameters
NomeTipo diRequirementDesignazione delle merci
type_id
Integer
Optional
Omit or use 0 for every type.
title_fr
stringa
Obbligatorio
French title.
title_en
stringa
Optional
English title.
items
array
Obbligatorio
Steps as strings or objects with label_fr, label_en, required and sort_order.
active
boolean
Optional
Active by default.
sort_order
Integer
Optional
Template order.
Output
Possible results
201Resource created
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxxxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/case/checklist/template/update
Chiave + Cuscinetto
Update a template and safely replace its steps.
Input
Corpo JSONAvailable parameters
NomeTipo diRequirementDesignazione delle merci
id
Integer
Obbligatorio
Template identifier.
type_id
Integer
Optional
Linked type or 0.
title_fr
stringa
Obbligatorio
French title.
title_en
stringa
Optional
English title.
items
array
Obbligatorio
Complete list replacing template steps.
active
boolean
Optional
Availability.
sort_order
Integer
Optional
Order.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxxxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/case/checklist/template/delete
Chiave + Cuscinetto
Delete an unused template or archive an applied template.
Input
Corpo JSONAvailable parameters
NomeTipo diRequirementDesignazione delle merci
id
Integer
Obbligatorio
An applied template will be archived.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxxxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}Punti di fine
Time tracking
Start, stop, add and audit technician time for every case.
5 routes ⌄
Punti di fine
Time tracking
Start, stop, add and audit technician time for every case.
/case/time/list
Chiave + Cuscinetto
List time entries and total tracked time for an authorised case.
Input
URL queryAvailable parameters
NomeTipo diRequirementDesignazione delle merci
case_id
Integer
Obbligatorio
Case assigned to the technician; supplier access is read-only.
technician_id
Integer
Optional
Supplier access only; assigned technician by default.
include_deleted
boolean
Optional
Supplier access only; include deleted entries and their reason.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxxxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"items": [],
"pagination": {
"page": 1,
"per_page": 25,
"total": 0,
"last_page": 1
}
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/case/time/start
Chiave + Cuscinetto
Start a live timer for the assigned technician.
Input
Corpo JSONAvailable parameters
NomeTipo diRequirementDesignazione delle merci
case_id
Integer
Obbligatorio
Case assigned to the signed-in technician.
note
stringa
Optional
Optional note, maximum 1,000 characters.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxxxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/case/time/stop
Chiave + Cuscinetto
Stop and calculate the active time entry.
Input
Corpo JSONAvailable parameters
NomeTipo diRequirementDesignazione delle merci
case_id
Integer
Obbligatorio
Case containing the active time entry.
entry_id
Integer
Optional
Active entry; the current case entry is used when omitted.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxxxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/case/time/add
Chiave + Cuscinetto
Manually add a date, start time and end time.
Input
Corpo JSONAvailable parameters
NomeTipo diRequirementDesignazione delle merci
case_id
Integer
Obbligatorio
Case assigned to the signed-in technician.
started_at
datetime
Obbligatorio
ISO 8601 date and time with timezone.
ended_at
datetime
Obbligatorio
After started_at; duration from 1 minute to 48 hours, without overlap.
note
stringa
Optional
Optional note.
Output
Possible results
201Resource created
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxxxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/case/time/delete
Chiave + Cuscinetto
Soft-delete a time entry with a mandatory reason retained in the audit trail.
Input
Corpo JSONAvailable parameters
NomeTipo diRequirementDesignazione delle merci
entry_id
Integer
Obbligatorio
Completed entry belonging to the technician.
reason
stringa
Obbligatorio
Mandatory reason from 5 to 1,000 characters.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxxxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}Punti di fine
Messages, photos and documents
Exchange data with the app, classify documents, send photos and retrieve authorised files.
10 routes ⌄
Punti di fine
Messages, photos and documents
Exchange data with the app, classify documents, send photos and retrieve authorised files.
/case/message/send
Chiave + Cuscinetto
Add a message to the case; the sender is identified automatically from the authenticated account.
Input
Corpo JSONAvailable parameters
NomeTipo diRequirementDesignazione delle merci
case_id
Integer
Obbligatorio
Case identifier.
message
stringa
Obbligatorio
Message to add.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxxxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/case/document-type/list
Chiave + Cuscinetto
List document types visible in the mobile app.
Input
URL queryAvailable parameters
NomeTipo diRequirementDesignazione delle merci
include_inactive
boolean
Optional
Supplier token only; includes archived types.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxxxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"items": [],
"pagination": {
"page": 1,
"per_page": 25,
"total": 0,
"last_page": 1
}
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/case/document-type/add
Chiave + Cuscinetto
Create a document type for the shop.
Input
Corpo JSONAvailable parameters
NomeTipo diRequirementDesignazione delle merci
label_fr
stringa
Obbligatorio
French type name.
label_en
stringa
Optional
English name; falls back to French.
icon
enumera
Optional
description | photo_camera | assignment | request_quote | receipt_long | verified | folder | build
color
hex
Optional
#RRGGBB
sort_order
Integer
Optional
Display order.
active
boolean
Optional
Active by default.
Output
Possible results
201Resource created
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxxxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/case/document-type/update
Chiave + Cuscinetto
Edit, reorder or hide a document type.
Input
Corpo JSONAvailable parameters
NomeTipo diRequirementDesignazione delle merci
id
Integer
Obbligatorio
Type identifier.
label_fr
stringa
Obbligatorio
French type name.
label_en
stringa
Optional
English name.
icon
enumera
Optional
description | photo_camera | assignment | request_quote | receipt_long | verified | folder | build
color
hex
Optional
#RRGGBB
sort_order
Integer
Optional
Display order.
active
boolean
Optional
Type availability.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxxxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/case/document-type/delete
Chiave + Cuscinetto
Delete an unused type or archive a type already in use.
Input
Corpo JSONAvailable parameters
NomeTipo diRequirementDesignazione delle merci
id
Integer
Obbligatorio
Type identifier. A type in use will be archived.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxxxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/case/document/list
Chiave + Cuscinetto
List all authorised documents newest first with their customer, technician or administrator source.
Input
URL queryAvailable parameters
NomeTipo diRequirementDesignazione delle merci
page
Integer
Optional
Numero di pagina, a partire da 1.
per_page
Integer
Optional
Number of results per page.
customer_id
Integer
Optional
Supplier-only filter.
case_id
Integer
Optional
Limit to one case.
unlinked_only
boolean
Optional
Return only documents not linked to a case.
document_type_id
Integer
Optional
Limit to one document type.
folder_path
stringa
Optional
Limit to an exact path, for example Reports / 2026.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxxxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"items": [],
"pagination": {
"page": 1,
"per_page": 25,
"total": 0,
"last_page": 1
}
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/case/document/add
Chiave + Cuscinetto
Add one or more photos, PDFs, documents or signatures, optionally linked to a checklist step.
Input
Corpo JSONAvailable parameters
NomeTipo diRequirementDesignazione delle merci
case_id
Integer
Optional
Optional case. Required when checklist_item_id is provided.
customer_id
Integer
Optional
Required with a supplier token when case_id is absent; ignored for an authenticated customer.
document_type_id
Integer
Optional
Classification type; an active default is used when omitted.
checklist_item_id
Integer
Optional
Checklist step that must belong to the specified case. Repeat the call to link multiple files.
title
stringa
Optional
Readable title; falls back to the file name.
folder_path
stringa
Optional
Free folder structure separated by /, maximum 8 levels.
note
stringa
Optional
Optional note, maximum 5,000 characters.
customer_visible
boolean
Optional
A supplier token can keep the document internal with false; mobile uploads remain visible.
kind
enumera
Optional
photo | document | signature
photo_stage
enumera
Optional
general | before | after
file_name
stringa
Obbligatorio
File name.
mime_type
enumera
Obbligatorio
image/jpeg | image/png | image/webp | application/pdf
content_base64
base64
Obbligatorio
Encoded file, maximum 6 MB.
Output
Possible results
201Resource created
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxxxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/case/document/get
Chiave + Cuscinetto
Download the Base64 content of an authorised document.
Input
URL queryAvailable parameters
NomeTipo diRequirementDesignazione delle merci
id
Integer
Obbligatorio
Document identifier.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxxxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/case/document/preview
Chiave + Cuscinetto
Load an optimised image thumbnail before opening and zooming.
Input
URL queryAvailable parameters
NomeTipo diRequirementDesignazione delle merci
id
Integer
Obbligatorio
Authorised image-document identifier.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxxxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/case/document/delete
Chiave + Cuscinetto
Delete a document that is not attached to a quote.
Input
Corpo JSONAvailable parameters
NomeTipo diRequirementDesignazione delle merci
id
Integer
Obbligatorio
Document identifier.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxxxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}Punti di fine
Quotes, approval and signature
Create detailed quotes, retrieve customer decisions and manage final intervention approval.
4 routes ⌄
Punti di fine
Quotes, approval and signature
Create detailed quotes, retrieve customer decisions and manage final intervention approval.
/case/quote/create
Chiave + Cuscinetto
Create and send a detailed quote with lines, discounts, VAT and an optional attachment.
Input
Corpo JSONAvailable parameters
NomeTipo diRequirementDesignazione delle merci
case_id
Integer
Obbligatorio
Case identifier.
lines
array
Obbligatorio
1 to 100 objects: description, quantity, unit_price, discount_percent and tax_rate.
notes
stringa
Optional
Maximum 5,000 characters.
valid_until
data
Optional
YYYYY-MM-DD
attachment
object
Optional
file_name, mime_type and content_base64; maximum 6 MB.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxxxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/case/quote/respond
Chiave + Cuscinetto
Accept or reject a quote sent to the customer.
Input
Corpo JSONAvailable parameters
NomeTipo diRequirementDesignazione delle merci
case_id
Integer
Obbligatorio
Case identifier.
quote_id
Integer
Obbligatorio
Quote identifier.
decision
enumera
Obbligatorio
accepted | rejected
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxxxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/case/validation/request
Chiave + Cuscinetto
Request customer approval and signature.
Input
Corpo JSONAvailable parameters
NomeTipo diRequirementDesignazione delle merci
case_id
Integer
Obbligatorio
Case identifier.
validation_type
stringa
Optional
Defaults to completion.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxxxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/case/validation/send
Chiave + Cuscinetto
Record the customer signature, either directly by the customer or on the assigned technician’s phone.
Input
Corpo JSONAvailable parameters
NomeTipo diRequirementDesignazione delle merci
case_id
Integer
Obbligatorio
Case identifier accessible to the customer or assigned technician.
validation_type
stringa
Optional
Defaults to completion.
signature_name
stringa
Obbligatorio
Name of the customer signing.
signature_base64
base64
Obbligatorio
PNG signature image encoded as Base64.
comment
stringa
Optional
Optional customer comment.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxxxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}Punti di fine
Planning, recurrence and reports
Automate recurring interventions and produce structured final-report data.
6 routes ⌄
Punti di fine
Planning, recurrence and reports
Automate recurring interventions and produce structured final-report data.
/case/recurrence/list
Chiave + Cuscinetto
List recurring services.
Input
URL queryAvailable parameters
No business parameter is expected. Send only the indicated authentication headers.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxxxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"items": [],
"pagination": {
"page": 1,
"per_page": 25,
"total": 0,
"last_page": 1
}
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/case/recurrence/add
Chiave + Cuscinetto
Create a recurrence from a source case.
Input
Corpo JSONAvailable parameters
NomeTipo diRequirementDesignazione delle merci
source_case_id
Integer
Obbligatorio
Case used as the template.
frequency
enumera
Obbligatorio
daily | weekly | monthly | yearly
interval_value
Integer
Optional
1 - 52
next_run_at
datetime
Obbligatorio
YYYY-MM-DD HH:MM:SS
end_at
datetime
Optional
Optional end date.
Output
Possible results
201Resource created
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxxxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/case/recurrence/update
Chiave + Cuscinetto
Update a recurring service.
Input
Corpo JSONAvailable parameters
NomeTipo diRequirementDesignazione delle merci
id
Integer
Obbligatorio
Recurrence identifier.
source_case_id
Integer
Obbligatorio
Source case.
frequency
enumera
Obbligatorio
daily | weekly | monthly | yearly
interval_value
Integer
Optional
1 - 52
next_run_at
datetime
Obbligatorio
YYYY-MM-DD HH:MM:SS
end_at
datetime
Optional
Optional end date.
active
boolean
Optional
Active recurrence.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxxxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/case/recurrence/delete
Chiave + Cuscinetto
Stop a recurring service.
Input
Corpo JSONAvailable parameters
NomeTipo diRequirementDesignazione delle merci
id
Integer
Obbligatorio
Recurrence identifier.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxxxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/case/recurrence/process
Chiave + Cuscinetto
Generate recurring services that are due.
Input
Corpo JSONAvailable parameters
NomeTipo diRequirementDesignazione delle merci
limit
Integer
Optional
Maximum 200 creations per call.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxxxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/case/report/summary
Chiave + Cuscinetto
Prepare the final report with fields and before/after photos.
Input
URL queryAvailable parameters
NomeTipo diRequirementDesignazione delle merci
case_id
Integer
Obbligatorio
Report case.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxxxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}Punti di fine
Notifiche
Retrieve customer or technician alerts and synchronise their read status.
2 routes ⌄
Punti di fine
Notifiche
Retrieve customer or technician alerts and synchronise their read status.
/case/notification/list
Chiave + Cuscinetto
List automatic notifications for the signed-in customer or technician.
Input
URL queryAvailable parameters
NomeTipo diRequirementDesignazione delle merci
limit
Integer
Optional
1 - 100
recipient_type
enumera
Optional
Supplier token only: customer or technician.
recipient_id
Integer
Optional
Supplier token only.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxxxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"items": [],
"pagination": {
"page": 1,
"per_page": 25,
"total": 0,
"last_page": 1
}
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/case/notification/read
Chiave + Cuscinetto
Mark one or every notification as read.
Input
Corpo JSONAvailable parameters
NomeTipo diRequirementDesignazione delle merci
id
Integer
Optional
Omit to mark all notifications as read.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxxxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}Punti di fine
Knowledge base
Supply procedures, FAQs and technical documents available to technicians in the mobile app.
12 routes ⌄
Punti di fine
Knowledge base
Supply procedures, FAQs and technical documents available to technicians in the mobile app.
/case/knowledge/categories
Chiave + Cuscinetto
List knowledge-base categories. On mobile, access is restricted to active technicians.
Input
URL queryAvailable parameters
NomeTipo diRequirementDesignazione delle merci
include_inactive
boolean
Optional
Supplier token only.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxxxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/case/knowledge/search
Chiave + Cuscinetto
Quickly search FAQs, information, procedures and documents by keyword. Mobile access is technician-only.
Input
URL queryAvailable parameters
NomeTipo diRequirementDesignazione delle merci
q
stringa
Optional
Keyword or phrase, maximum 120 characters.
category_id
Integer
Optional
Filter by category.
type
enumera
Optional
faq | information | procedure | document
page
Integer
Optional
Page, defaults to 1.
limit
Integer
Optional
1 to 50 results.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxxxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/case/knowledge/detail
Chiave + Cuscinetto
Open an entry and list its attachments without loading large files.
Input
URL queryAvailable parameters
NomeTipo diRequirementDesignazione delle merci
id
Integer
Obbligatorio
Entry identifier.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxxxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/case/knowledge/document
Chiave + Cuscinetto
Download an authorised Base64 attachment.
Input
URL queryAvailable parameters
NomeTipo diRequirementDesignazione delle merci
id
Integer
Obbligatorio
Attachment identifier.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxxxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/case/knowledge/category/add
Chiave + Cuscinetto
Create a knowledge category.
Input
Corpo JSONAvailable parameters
NomeTipo diRequirementDesignazione delle merci
title_fr
stringa
Obbligatorio
French title.
title_en
stringa
Optional
English title with French fallback.
description_fr
stringa
Optional
French description.
description_en
stringa
Optional
English description.
color
hex
Optional
#RRGGBB
active
boolean
Optional
Visible by default.
sort_order
Integer
Optional
Order.
Output
Possible results
201Resource created
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxxxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/case/knowledge/category/update
Chiave + Cuscinetto
Edit, reorder or hide a category.
Input
Corpo JSONAvailable parameters
NomeTipo diRequirementDesignazione delle merci
id
Integer
Obbligatorio
Category identifier.
title_fr
stringa
Obbligatorio
French title.
title_en
stringa
Optional
English title.
active
boolean
Optional
Visibility.
sort_order
Integer
Optional
Order.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxxxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/case/knowledge/category/delete
Chiave + Cuscinetto
Delete a category while retaining its entries as uncategorised.
Input
Corpo JSONAvailable parameters
NomeTipo diRequirementDesignazione delle merci
id
Integer
Obbligatorio
Category identifier.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxxxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/case/knowledge/article/add
Chiave + Cuscinetto
Create a FAQ, information entry, procedure or documentation.
Input
Corpo JSONAvailable parameters
NomeTipo diRequirementDesignazione delle merci
category_id
Integer
Optional
Optional category.
content_type
enumera
Obbligatorio
faq | information | procedure | document
title_fr
stringa
Obbligatorio
French title.
title_en
stringa
Optional
English title.
summary_fr
stringa
Optional
French summary.
summary_en
stringa
Optional
English summary.
content_fr
stringa
Optional
French content.
content_en
stringa
Optional
English content.
keywords
stringa
Optional
Comma-separated keywords.
featured
boolean
Optional
Featured.
active
boolean
Optional
Published.
sort_order
Integer
Optional
Order.
Output
Possible results
201Resource created
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxxxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/case/knowledge/article/update
Chiave + Cuscinetto
Edit and publish an entry.
Input
Corpo JSONAvailable parameters
NomeTipo diRequirementDesignazione delle merci
id
Integer
Obbligatorio
Entry identifier.
content_type
enumera
Obbligatorio
faq | information | procedure | document
title_fr
stringa
Obbligatorio
French title.
title_en
stringa
Optional
English title.
content_fr
stringa
Optional
French content.
content_en
stringa
Optional
English content.
active
boolean
Optional
Published.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxxxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/case/knowledge/article/delete
Chiave + Cuscinetto
Delete an entry and its attachments.
Input
Corpo JSONAvailable parameters
NomeTipo diRequirementDesignazione delle merci
id
Integer
Obbligatorio
Entry identifier.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxxxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/case/knowledge/document/add
Chiave + Cuscinetto
Attach a document up to 8 MB.
Input
Corpo JSONAvailable parameters
NomeTipo diRequirementDesignazione delle merci
article_id
Integer
Obbligatorio
Parent entry.
title_fr
stringa
Optional
French title.
title_en
stringa
Optional
English title.
file_name
stringa
Obbligatorio
File name.
mime_type
stringa
Obbligatorio
Allowed MIME type.
content_base64
base64
Obbligatorio
Maximum 8 MB.
Output
Possible results
201Resource created
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxxxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}/case/knowledge/document/delete
Chiave + Cuscinetto
Delete an attachment.
Input
Corpo JSONAvailable parameters
NomeTipo diRequirementDesignazione delle merci
id
Integer
Obbligatorio
Attachment identifier.
Output
Possible results
200Successful operation
400Invalid request or JSON
401Missing or invalid authentication
403Insufficient access
404Requested resource not found
409Conflict with existing data
422Parameter rejected by validation
429Request limit reached
5xxxxTemporary technical incident
Success example
{
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}Error example
{
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}Nessun endpoint corrisponde alla tua ricerca.
Reference
Responses and errors
Each row has a “Parameters and responses” button showing required or optional fields, possible statuses and JSON examples. An empty list means the resource is not populated yet, not that the endpoint is down.
400Richiesta non valida
401Autenticazione richiesta
403Accesso negato
404Risorse o percorso non trovato
409conflitto commerciale
422Mancato il mancato convalida
429Troppe richieste
5xxxxIncidenza tecnica