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 · Acompanhamento de processos
Ligue o seu software ao acompanhamento de processos SellViaApp.
Crie e acompanhe intervenções, atribua técnicos e gira mensagens, documentos, orçamentos, aprovações, checklists, recorrências e tempos a partir do seu sistema.
URL base
https://api.sellviaapp.com/Required headers
Developer supportapi@sellviaapp.com
X-API-Key + BearerInício rápido
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.
Pontos finais
Cases and lifecycle
Create, search, retrieve and update a case: status, priority, progress, appointments, assignment and technician mission.
5 routes ⌄
Pontos finais
Cases and lifecycle
Create, search, retrieve and update a case: status, priority, progress, appointments, assignment and technician mission.
/case/list
Chave + Carregador
List the signed-in customer cases; a supplier token can list every case.
Input
URL queryAvailable parameters
NomeTipoRequirementDesignação das mercadorias
page
inteiro
Optional
Número da página, começando em 1.
per_page
inteiro
Optional
Number of results per page.
customer_id
inteiro
Optional
Required only with an integration token when the operation targets a specific customer.
status
string
Optional
Filter by status code.
type_id
inteiro
Optional
Filter by intervention type.
priority
enum
Optional
low | normal | high | urgent
q
string
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
5xxTemporary 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
Chave + Carregador
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
NomeTipoRequirementDesignação das mercadorias
id
inteiro
Necessário
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
5xxTemporary 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
Chave + Carregador
Create a service request linked to the customer.
Input
Corpo JSONAvailable parameters
NomeTipoRequirementDesignação das mercadorias
customer_id
inteiro
Optional
Required only with a supplier token.
type_id
inteiro
Optional
Active intervention type.
title
string
Necessário
Short request title.
description
string
Necessário
Problem or request description.
status
string
Optional
Supplier only; defaults to new.
priority
enum
Optional
low | normal | high | urgent
progress
inteiro
Optional
0 - 100
address
string
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
string
Optional
Assigned person or team.
technician_id
inteiro
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
5xxTemporary 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
Chave + Carregador
Update customer, type, status, priority, progress, appointment and assignment.
Input
Corpo JSONAvailable parameters
NomeTipoRequirementDesignação das mercadorias
id
inteiro
Necessário
Case identifier.
customer_id
inteiro
Optional
Linked customer; 0 removes the link.
type_id
inteiro
Optional
Type; 0 removes the type.
title
string
Optional
Case title.
description
string
Optional
Detailed description.
status
string
Optional
Code returned by case/status/list.
priority
enum
Optional
low | normal | high | urgent
progress
inteiro
Optional
0 - 100
address
string
Optional
Service address.
appointment_start
datetime
Optional
Empty to clear the date.
appointment_end
datetime
Optional
Empty to clear the date.
assigned_to
string
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
5xxTemporary 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
Chave + Carregador
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
5xxTemporary 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"
}
}
}Pontos finais
Types and forms
Let the ERP manage intervention types and custom fields requested in the mobile app.
8 routes ⌄
Pontos finais
Types and forms
Let the ERP manage intervention types and custom fields requested in the mobile app.
/case/type/list
Chave + Carregador
List available intervention types.
Input
URL queryAvailable parameters
NomeTipoRequirementDesignação das mercadorias
include_inactive
booleano
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
5xxTemporary 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
Chave + Carregador
Create an intervention type.
Input
Corpo JSONAvailable parameters
NomeTipoRequirementDesignação das mercadorias
name
string
Necessário
Type name.
description
string
Optional
Maximum 2,000 characters.
sort_order
inteiro
Optional
Display order.
active
booleano
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
5xxTemporary 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
Chave + Carregador
Edit, reorder or hide an intervention type.
Input
Corpo JSONAvailable parameters
NomeTipoRequirementDesignação das mercadorias
id
inteiro
Necessário
Type identifier.
name
string
Necessário
Type name.
description
string
Optional
Description.
sort_order
inteiro
Optional
Display order.
active
booleano
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
5xxTemporary 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
Chave + Carregador
Delete an unused type or archive a linked type.
Input
Corpo JSONAvailable parameters
NomeTipoRequirementDesignação das mercadorias
id
inteiro
Necessário
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
5xxTemporary 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
Chave + Carregador
List custom service-request fields.
Input
URL queryAvailable parameters
NomeTipoRequirementDesignação das mercadorias
type_id
inteiro
Optional
Limit to global fields and the selected type.
include_inactive
booleano
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
5xxTemporary 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
Chave + Carregador
Add information to request from customers.
Input
Corpo JSONAvailable parameters
NomeTipoRequirementDesignação das mercadorias
type_id
inteiro
Optional
0 or omitted for every type.
label_fr
string
Necessário
French label.
label_en
string
Optional
English label.
field_type
enum
Necessário
text | textarea | select | boolean | date | number
options
array
Optional
Required for select.
required
booleano
Optional
Required answer.
sort_order
inteiro
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
5xxTemporary 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
Chave + Carregador
Update a custom request field.
Input
Corpo JSONAvailable parameters
NomeTipoRequirementDesignação das mercadorias
id
inteiro
Necessário
Field identifier.
type_id
inteiro
Optional
Linked type or 0.
label_fr
string
Necessário
French label.
label_en
string
Optional
English label.
field_type
enum
Necessário
text | textarea | select | boolean | date | number
options
array
Optional
Menu options.
required
booleano
Optional
Required answer.
active
booleano
Optional
Visible field.
sort_order
inteiro
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
5xxTemporary 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
Chave + Carregador
Delete or archive a custom request field.
Input
Corpo JSONAvailable parameters
NomeTipoRequirementDesignação das mercadorias
id
inteiro
Necessário
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
5xxTemporary 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"
}
}
}Pontos finais
Technicians and assignments
Synchronise field teams, skills and roles, then assign every intervention to the right technician.
5 routes ⌄
Pontos finais
Technicians and assignments
Synchronise field teams, skills and roles, then assign every intervention to the right technician.
/case/technician/list
Chave + Carregador
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
5xxTemporary 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
Chave + Carregador
Retrieve a technician’s complete professional record.
Input
URL queryAvailable parameters
NomeTipoRequirementDesignação das mercadorias
technician_id
inteiro
Necessário
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
5xxTemporary 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
Chave + Carregador
Create or update a technician account’s professional profile.
Input
Corpo JSONAvailable parameters
NomeTipoRequirementDesignação das mercadorias
technician_id
inteiro
Necessário
Mobile account to configure as technician.
employee_code
string
Optional
Employee or internal code.
job_title
string
Optional
Technician job title.
specialties
string
Optional
Field specialities.
skills
string
Optional
Skills and certifications.
service_area
string
Optional
Service area.
availability_notes
string
Optional
Usual availability.
emergency_available
booleano
Optional
Available for emergencies.
internal_notes
string
Optional
Internal notes hidden in the app.
profile_color
string
Optional
#RRGGBB
active
booleano
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
5xxTemporary 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
Chave + Carregador
Assign the Customer or Technician role to a mobile account.
Input
Corpo JSONAvailable parameters
NomeTipoRequirementDesignação das mercadorias
customer_id
inteiro
Necessário
Mobile account.
role
enum
Necessário
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
5xxTemporary 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
Chave + Carregador
Allow the assigned technician to update status and progress.
Input
Corpo JSONAvailable parameters
NomeTipoRequirementDesignação das mercadorias
case_id
inteiro
Necessário
Service assigned to the signed-in technician.
status
enum
Necessário
planned | in_progress | waiting_customer | completed
progress
inteiro
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
5xxTemporary 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"
}
}
}Pontos finais
Missions and checklists
Prepare procedures, retrieve applied steps and record field completion.
7 routes ⌄
Pontos finais
Missions and checklists
Prepare procedures, retrieve applied steps and record field completion.
/case/checklist/list
Chave + Carregador
Retrieve the checklist and progress for an authorised case.
Input
URL queryAvailable parameters
NomeTipoRequirementDesignação das mercadorias
case_id
inteiro
Necessário
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
5xxTemporary 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
Chave + Carregador
Set the private mission visible only to the assigned technician.
Input
Corpo JSONAvailable parameters
NomeTipoRequirementDesignação das mercadorias
case_id
inteiro
Necessário
Case whose mission is being set.
mission_note
string
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
5xxTemporary 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
Chave + Carregador
Complete or reopen a step; assigned technician or supplier only.
Input
Corpo JSONAvailable parameters
NomeTipoRequirementDesignação das mercadorias
case_id
inteiro
Necessário
Case assigned to the technician.
item_id
inteiro
Necessário
Checklist step.
completed
booleano
Necessário
Complete or reopen the step.
note
string
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
5xxTemporary 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
Chave + Carregador
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
5xxTemporary 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
Chave + Carregador
Create a global checklist or one linked to an intervention type.
Input
Corpo JSONAvailable parameters
NomeTipoRequirementDesignação das mercadorias
type_id
inteiro
Optional
Omit or use 0 for every type.
title_fr
string
Necessário
French title.
title_en
string
Optional
English title.
items
array
Necessário
Steps as strings or objects with label_fr, label_en, required and sort_order.
active
booleano
Optional
Active by default.
sort_order
inteiro
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
5xxTemporary 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
Chave + Carregador
Update a template and safely replace its steps.
Input
Corpo JSONAvailable parameters
NomeTipoRequirementDesignação das mercadorias
id
inteiro
Necessário
Template identifier.
type_id
inteiro
Optional
Linked type or 0.
title_fr
string
Necessário
French title.
title_en
string
Optional
English title.
items
array
Necessário
Complete list replacing template steps.
active
booleano
Optional
Availability.
sort_order
inteiro
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
5xxTemporary 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
Chave + Carregador
Delete an unused template or archive an applied template.
Input
Corpo JSONAvailable parameters
NomeTipoRequirementDesignação das mercadorias
id
inteiro
Necessário
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
5xxTemporary 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"
}
}
}Pontos finais
Time tracking
Start, stop, add and audit technician time for every case.
5 routes ⌄
Pontos finais
Time tracking
Start, stop, add and audit technician time for every case.
/case/time/list
Chave + Carregador
List time entries and total tracked time for an authorised case.
Input
URL queryAvailable parameters
NomeTipoRequirementDesignação das mercadorias
case_id
inteiro
Necessário
Case assigned to the technician; supplier access is read-only.
technician_id
inteiro
Optional
Supplier access only; assigned technician by default.
include_deleted
booleano
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
5xxTemporary 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
Chave + Carregador
Start a live timer for the assigned technician.
Input
Corpo JSONAvailable parameters
NomeTipoRequirementDesignação das mercadorias
case_id
inteiro
Necessário
Case assigned to the signed-in technician.
note
string
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
5xxTemporary 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
Chave + Carregador
Stop and calculate the active time entry.
Input
Corpo JSONAvailable parameters
NomeTipoRequirementDesignação das mercadorias
case_id
inteiro
Necessário
Case containing the active time entry.
entry_id
inteiro
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
5xxTemporary 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
Chave + Carregador
Manually add a date, start time and end time.
Input
Corpo JSONAvailable parameters
NomeTipoRequirementDesignação das mercadorias
case_id
inteiro
Necessário
Case assigned to the signed-in technician.
started_at
datetime
Necessário
ISO 8601 date and time with timezone.
ended_at
datetime
Necessário
After started_at; duration from 1 minute to 48 hours, without overlap.
note
string
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
5xxTemporary 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
Chave + Carregador
Soft-delete a time entry with a mandatory reason retained in the audit trail.
Input
Corpo JSONAvailable parameters
NomeTipoRequirementDesignação das mercadorias
entry_id
inteiro
Necessário
Completed entry belonging to the technician.
reason
string
Necessário
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
5xxTemporary 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"
}
}
}Pontos finais
Messages, photos and documents
Exchange data with the app, classify documents, send photos and retrieve authorised files.
10 routes ⌄
Pontos finais
Messages, photos and documents
Exchange data with the app, classify documents, send photos and retrieve authorised files.
/case/message/send
Chave + Carregador
Add a message to the case; the sender is identified automatically from the authenticated account.
Input
Corpo JSONAvailable parameters
NomeTipoRequirementDesignação das mercadorias
case_id
inteiro
Necessário
Case identifier.
message
string
Necessário
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
5xxTemporary 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
Chave + Carregador
List document types visible in the mobile app.
Input
URL queryAvailable parameters
NomeTipoRequirementDesignação das mercadorias
include_inactive
booleano
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
5xxTemporary 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
Chave + Carregador
Create a document type for the shop.
Input
Corpo JSONAvailable parameters
NomeTipoRequirementDesignação das mercadorias
label_fr
string
Necessário
French type name.
label_en
string
Optional
English name; falls back to French.
icon
enum
Optional
description | photo_camera | assignment | request_quote | receipt_long | verified | folder | build
color
hex
Optional
#RRGGBB
sort_order
inteiro
Optional
Display order.
active
booleano
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
5xxTemporary 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
Chave + Carregador
Edit, reorder or hide a document type.
Input
Corpo JSONAvailable parameters
NomeTipoRequirementDesignação das mercadorias
id
inteiro
Necessário
Type identifier.
label_fr
string
Necessário
French type name.
label_en
string
Optional
English name.
icon
enum
Optional
description | photo_camera | assignment | request_quote | receipt_long | verified | folder | build
color
hex
Optional
#RRGGBB
sort_order
inteiro
Optional
Display order.
active
booleano
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
5xxTemporary 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
Chave + Carregador
Delete an unused type or archive a type already in use.
Input
Corpo JSONAvailable parameters
NomeTipoRequirementDesignação das mercadorias
id
inteiro
Necessário
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
5xxTemporary 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
Chave + Carregador
List all authorised documents newest first with their customer, technician or administrator source.
Input
URL queryAvailable parameters
NomeTipoRequirementDesignação das mercadorias
page
inteiro
Optional
Número da página, começando em 1.
per_page
inteiro
Optional
Number of results per page.
customer_id
inteiro
Optional
Supplier-only filter.
case_id
inteiro
Optional
Limit to one case.
unlinked_only
booleano
Optional
Return only documents not linked to a case.
document_type_id
inteiro
Optional
Limit to one document type.
folder_path
string
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
5xxTemporary 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
Chave + Carregador
Add one or more photos, PDFs, documents or signatures, optionally linked to a checklist step.
Input
Corpo JSONAvailable parameters
NomeTipoRequirementDesignação das mercadorias
case_id
inteiro
Optional
Optional case. Required when checklist_item_id is provided.
customer_id
inteiro
Optional
Required with a supplier token when case_id is absent; ignored for an authenticated customer.
document_type_id
inteiro
Optional
Classification type; an active default is used when omitted.
checklist_item_id
inteiro
Optional
Checklist step that must belong to the specified case. Repeat the call to link multiple files.
title
string
Optional
Readable title; falls back to the file name.
folder_path
string
Optional
Free folder structure separated by /, maximum 8 levels.
note
string
Optional
Optional note, maximum 5,000 characters.
customer_visible
booleano
Optional
A supplier token can keep the document internal with false; mobile uploads remain visible.
kind
enum
Optional
photo | document | signature
photo_stage
enum
Optional
general | before | after
file_name
string
Necessário
File name.
mime_type
enum
Necessário
image/jpeg | image/png | image/webp | application/pdf
content_base64
base64
Necessário
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
5xxTemporary 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
Chave + Carregador
Download the Base64 content of an authorised document.
Input
URL queryAvailable parameters
NomeTipoRequirementDesignação das mercadorias
id
inteiro
Necessário
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
5xxTemporary 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
Chave + Carregador
Load an optimised image thumbnail before opening and zooming.
Input
URL queryAvailable parameters
NomeTipoRequirementDesignação das mercadorias
id
inteiro
Necessário
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
5xxTemporary 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
Chave + Carregador
Delete a document that is not attached to a quote.
Input
Corpo JSONAvailable parameters
NomeTipoRequirementDesignação das mercadorias
id
inteiro
Necessário
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
5xxTemporary 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"
}
}
}Pontos finais
Quotes, approval and signature
Create detailed quotes, retrieve customer decisions and manage final intervention approval.
4 routes ⌄
Pontos finais
Quotes, approval and signature
Create detailed quotes, retrieve customer decisions and manage final intervention approval.
/case/quote/create
Chave + Carregador
Create and send a detailed quote with lines, discounts, VAT and an optional attachment.
Input
Corpo JSONAvailable parameters
NomeTipoRequirementDesignação das mercadorias
case_id
inteiro
Necessário
Case identifier.
lines
array
Necessário
1 to 100 objects: description, quantity, unit_price, discount_percent and tax_rate.
notes
string
Optional
Maximum 5,000 characters.
valid_until
data
Optional
AAAA-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
5xxTemporary 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
Chave + Carregador
Accept or reject a quote sent to the customer.
Input
Corpo JSONAvailable parameters
NomeTipoRequirementDesignação das mercadorias
case_id
inteiro
Necessário
Case identifier.
quote_id
inteiro
Necessário
Quote identifier.
decision
enum
Necessário
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
5xxTemporary 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
Chave + Carregador
Request customer approval and signature.
Input
Corpo JSONAvailable parameters
NomeTipoRequirementDesignação das mercadorias
case_id
inteiro
Necessário
Case identifier.
validation_type
string
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
5xxTemporary 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
Chave + Carregador
Record the customer signature, either directly by the customer or on the assigned technician’s phone.
Input
Corpo JSONAvailable parameters
NomeTipoRequirementDesignação das mercadorias
case_id
inteiro
Necessário
Case identifier accessible to the customer or assigned technician.
validation_type
string
Optional
Defaults to completion.
signature_name
string
Necessário
Name of the customer signing.
signature_base64
base64
Necessário
PNG signature image encoded as Base64.
comment
string
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
5xxTemporary 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"
}
}
}Pontos finais
Planning, recurrence and reports
Automate recurring interventions and produce structured final-report data.
6 routes ⌄
Pontos finais
Planning, recurrence and reports
Automate recurring interventions and produce structured final-report data.
/case/recurrence/list
Chave + Carregador
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
5xxTemporary 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
Chave + Carregador
Create a recurrence from a source case.
Input
Corpo JSONAvailable parameters
NomeTipoRequirementDesignação das mercadorias
source_case_id
inteiro
Necessário
Case used as the template.
frequency
enum
Necessário
daily | weekly | monthly | yearly
interval_value
inteiro
Optional
1 - 52
next_run_at
datetime
Necessário
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
5xxTemporary 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
Chave + Carregador
Update a recurring service.
Input
Corpo JSONAvailable parameters
NomeTipoRequirementDesignação das mercadorias
id
inteiro
Necessário
Recurrence identifier.
source_case_id
inteiro
Necessário
Source case.
frequency
enum
Necessário
daily | weekly | monthly | yearly
interval_value
inteiro
Optional
1 - 52
next_run_at
datetime
Necessário
YYYY-MM-DD HH:MM:SS
end_at
datetime
Optional
Optional end date.
active
booleano
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
5xxTemporary 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
Chave + Carregador
Stop a recurring service.
Input
Corpo JSONAvailable parameters
NomeTipoRequirementDesignação das mercadorias
id
inteiro
Necessário
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
5xxTemporary 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
Chave + Carregador
Generate recurring services that are due.
Input
Corpo JSONAvailable parameters
NomeTipoRequirementDesignação das mercadorias
limit
inteiro
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
5xxTemporary 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
Chave + Carregador
Prepare the final report with fields and before/after photos.
Input
URL queryAvailable parameters
NomeTipoRequirementDesignação das mercadorias
case_id
inteiro
Necessário
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
5xxTemporary 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"
}
}
}Pontos finais
Notificações
Retrieve customer or technician alerts and synchronise their read status.
2 routes ⌄
Pontos finais
Notificações
Retrieve customer or technician alerts and synchronise their read status.
/case/notification/list
Chave + Carregador
List automatic notifications for the signed-in customer or technician.
Input
URL queryAvailable parameters
NomeTipoRequirementDesignação das mercadorias
limit
inteiro
Optional
1 - 100
recipient_type
enum
Optional
Supplier token only: customer or technician.
recipient_id
inteiro
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
5xxTemporary 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
Chave + Carregador
Mark one or every notification as read.
Input
Corpo JSONAvailable parameters
NomeTipoRequirementDesignação das mercadorias
id
inteiro
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
5xxTemporary 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"
}
}
}Pontos finais
Knowledge base
Supply procedures, FAQs and technical documents available to technicians in the mobile app.
12 routes ⌄
Pontos finais
Knowledge base
Supply procedures, FAQs and technical documents available to technicians in the mobile app.
/case/knowledge/categories
Chave + Carregador
List knowledge-base categories. On mobile, access is restricted to active technicians.
Input
URL queryAvailable parameters
NomeTipoRequirementDesignação das mercadorias
include_inactive
booleano
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
5xxTemporary 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
Chave + Carregador
Quickly search FAQs, information, procedures and documents by keyword. Mobile access is technician-only.
Input
URL queryAvailable parameters
NomeTipoRequirementDesignação das mercadorias
q
string
Optional
Keyword or phrase, maximum 120 characters.
category_id
inteiro
Optional
Filter by category.
type
enum
Optional
faq | information | procedure | document
page
inteiro
Optional
Page, defaults to 1.
limit
inteiro
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
5xxTemporary 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
Chave + Carregador
Open an entry and list its attachments without loading large files.
Input
URL queryAvailable parameters
NomeTipoRequirementDesignação das mercadorias
id
inteiro
Necessário
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
5xxTemporary 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
Chave + Carregador
Download an authorised Base64 attachment.
Input
URL queryAvailable parameters
NomeTipoRequirementDesignação das mercadorias
id
inteiro
Necessário
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
5xxTemporary 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
Chave + Carregador
Create a knowledge category.
Input
Corpo JSONAvailable parameters
NomeTipoRequirementDesignação das mercadorias
title_fr
string
Necessário
French title.
title_en
string
Optional
English title with French fallback.
description_fr
string
Optional
French description.
description_en
string
Optional
English description.
color
hex
Optional
#RRGGBB
active
booleano
Optional
Visible by default.
sort_order
inteiro
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
5xxTemporary 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
Chave + Carregador
Edit, reorder or hide a category.
Input
Corpo JSONAvailable parameters
NomeTipoRequirementDesignação das mercadorias
id
inteiro
Necessário
Category identifier.
title_fr
string
Necessário
French title.
title_en
string
Optional
English title.
active
booleano
Optional
Visibility.
sort_order
inteiro
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
5xxTemporary 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
Chave + Carregador
Delete a category while retaining its entries as uncategorised.
Input
Corpo JSONAvailable parameters
NomeTipoRequirementDesignação das mercadorias
id
inteiro
Necessário
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
5xxTemporary 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
Chave + Carregador
Create a FAQ, information entry, procedure or documentation.
Input
Corpo JSONAvailable parameters
NomeTipoRequirementDesignação das mercadorias
category_id
inteiro
Optional
Optional category.
content_type
enum
Necessário
faq | information | procedure | document
title_fr
string
Necessário
French title.
title_en
string
Optional
English title.
summary_fr
string
Optional
French summary.
summary_en
string
Optional
English summary.
content_fr
string
Optional
French content.
content_en
string
Optional
English content.
keywords
string
Optional
Comma-separated keywords.
featured
booleano
Optional
Featured.
active
booleano
Optional
Published.
sort_order
inteiro
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
5xxTemporary 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
Chave + Carregador
Edit and publish an entry.
Input
Corpo JSONAvailable parameters
NomeTipoRequirementDesignação das mercadorias
id
inteiro
Necessário
Entry identifier.
content_type
enum
Necessário
faq | information | procedure | document
title_fr
string
Necessário
French title.
title_en
string
Optional
English title.
content_fr
string
Optional
French content.
content_en
string
Optional
English content.
active
booleano
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
5xxTemporary 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
Chave + Carregador
Delete an entry and its attachments.
Input
Corpo JSONAvailable parameters
NomeTipoRequirementDesignação das mercadorias
id
inteiro
Necessário
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
5xxTemporary 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
Chave + Carregador
Attach a document up to 8 MB.
Input
Corpo JSONAvailable parameters
NomeTipoRequirementDesignação das mercadorias
article_id
inteiro
Necessário
Parent entry.
title_fr
string
Optional
French title.
title_en
string
Optional
English title.
file_name
string
Necessário
File name.
mime_type
string
Necessário
Allowed MIME type.
content_base64
base64
Necessário
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
5xxTemporary 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
Chave + Carregador
Delete an attachment.
Input
Corpo JSONAvailable parameters
NomeTipoRequirementDesignação das mercadorias
id
inteiro
Necessário
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
5xxTemporary 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"
}
}
}Nenhum ponto final corresponde à sua pesquisa.
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.
400Pedido inválido
401Autenticação necessária
403Acesso negado
404Recurso ou rota não encontrado
409Conflito de negócios
422A validação falhou
429Muitos pedidos
5xxIncidente técnico