synchroteam_list_customers
List customers
List or search customers (name wildcard, e-mail, active flag, change time). Returns name, address, contact, custom fields, tags. GET /customer/list.
Parametersnamepagesortemailactivepage_sizesort_orderchanged_since
synchroteam_get_customer
Get customer
One customer by id, myId, exact name or e-mail, with address, contact, custom fields and tags. GET /customer/details.
Parametersbyrequiredvaluerequired
synchroteam_list_sites
List sites
List or search sites (a customer's locations): by name, customer, active flag, change time. GET /site/list.
Parametersnamepagesortactivepage_sizesort_ordercustomer_idchanged_sincecustomer_my_id
synchroteam_get_site
Get site
One site by id, myId or exact name: address, contact, customer, custom fields, tags. GET /site/details.
Parametersbyrequiredvaluerequired
synchroteam_list_equipment
List equipment
List or search pieces of equipment (assets) by name, customer, site, active flag, change time. GET /equipment/list.
Parametersnamepagesortactivesite_idpage_sizesite_my_idsort_ordercustomer_idchanged_sincecustomer_my_id
synchroteam_get_equipment
Get equipment
One piece of equipment by id, myId or exact name, with its customer and site. GET /equipment/details.
Parametersbyrequiredvaluerequired
synchroteam_list_jobs
List jobs
List jobs (simplified: no report, parts or time entries) filtered by status, schedule window, technician, team, customer, site, equipment, job type or project. Use synchroteam_get_job for the full record. GET /job/list.
Parameterspageshowsortmy_idstatusdate_tosite_idteam_idtype_iduser_iddate_frompage_size+13 more
synchroteam_get_job
Get job
One job by num (the job number shown in the app), id or myId: status, customer/site/equipment, technician(s), schedule, actual times, time entries, parts used, report and custom fields. GET /job/details.
Parametersbyrequiredvaluerequired
synchroteam_get_job_photos
Get job photos
Photo links of a job (url, file name, comment, report iteration). Image bytes are never returned. GET /job/photos.
Parametersbyrequiredvaluerequired
synchroteam_list_job_types
List job types
List job types (name, default duration, priority, skills, default report). Use their id or name when creating a job. GET /jobtype/list.
Parametersnamepagepage_size
synchroteam_list_users
List users (technicians and staff)
List users: login, name, profile (technician, manager, administrator), teams, skills, last known location. Passwords are never returned. GET /user/list.
Parameterspageshowteam_idpage_sizeteam_nameskilled_trade
synchroteam_get_user
Get user
One user by login or id. GET /user/details.
Parametersbyrequiredvaluerequired
synchroteam_list_teams
List teams
List teams with member counts and tags. GET /team/list.
Parametersnamepageshowpage_size
synchroteam_list_parts
List parts and services
List the parts and services catalog (reference, name, price, category, tax, tracked/serialized flags, type). GET /part/list.
Parameterspagesorttypestatuspage_sizeis_trackedsort_ordercategory_idcategory_namechanged_sinceis_serializable
synchroteam_get_part
Get part
One part or service by id or reference. GET /part/details.
Parametersbyrequiredvaluerequired
synchroteam_list_depots
List stock depots
List stock depots (warehouses and technician vans). The part quantities of one depot come from synchroteam_get_depot. GET /depot/list.
Parametersnamepagesortpage_sizeis_defaultsort_orderis_provider
synchroteam_get_depot
Get depot stock
One stock depot by id, with the quantity of each part it holds. GET /depot/details.
Parametersidrequired
synchroteam_list_part_requests
List part requests
List technicians' part requests (urgent, sent, completed, deleted flags). GET /partrequest/list.
Parameterspageis_sentis_urgentpage_sizeis_deletedsort_orderis_completechanged_sincecreated_since
synchroteam_list_invoices
List invoices
List invoices (read only): number, status, customer, job, lines, totals. Filter by status, customer, site, job or time. GET /invoice/list.
Parameterspagejob_idstatusjob_numsite_idjob_my_idpage_sizepaid_sincesite_my_idsort_ordercustomer_idchanged_since+2 more
synchroteam_get_invoice
Get invoice
One invoice by id, reference or number, with its lines. GET /invoice/details.
Parametersbyrequiredvaluerequired
synchroteam_list_quotations
List quotations
List quotations (read only): number, status, customer, job, lines, totals. GET /quotation/list.
Parameterspagejob_idstatusjob_numsite_idjob_my_idpage_sizesite_my_idsort_ordercustomer_idchanged_sincecreated_since+1 more
synchroteam_get_quotation
Get quotation
One quotation by id, reference or number, with its lines. GET /quotation/details.
Parametersbyrequiredvaluerequired
synchroteam_list_contracts
List contracts
List service contracts by name, customer, site, period or active flag. GET /contract/list.
Parametersendnamepagesortstartactivesite_idpage_sizesite_my_idsort_ordercustomer_idcustomer_my_id
synchroteam_list_projects
List projects
List projects (groups of jobs) by customer, site, equipment or project type. GET /project/list.
Parameterspagesite_idtype_idpage_sizetype_namesite_my_idsort_ordercustomer_idequipment_idcustomer_my_idequipment_my_id
synchroteam_list_activities
List technician activities
List time entries and unavailabilities (travel, at work, clock, unavailable) of technicians. start_date and end_date go together and return anything overlapping that range. GET /activity/list.
Parameterspagesortteam_iduser_idend_datepage_sizesort_orderstart_dateuser_loginactivity_type_nameactivity_type_category
synchroteam_create_customer
Create customer
WRITE: create a new customer (name and an address are required). If you pass myId and a customer with that myId already exists, nothing is created and an error is returned (use synchroteam_update_customer). POST /customer/send.
Parametersnamerequiredmy_idaddressvat_numbercontact_faxcontact_emailcontact_phoneaddressComplementcontact_last_namecontact_first_name
synchroteam_update_customer
Update customer
WRITE: change fields of an existing customer by its numeric id. Only the fields you pass are changed; nothing is cleared. The customer id must exist (an unknown id fails). POST /customer/send.
Parametersidrequirednameaddressvat_numbercontact_faxcontact_emailcontact_phoneaddressComplementcontact_last_namecontact_first_name
synchroteam_create_site
Create site
WRITE: create a new site (a location of a customer). Needs a name, an address and the customer (id or myId). If myId already exists nothing is created and an error is returned. POST /site/send.
Parametersnamerequiredmy_idaddresscustomerrequiredcontact_namecontact_emailcontact_phonecontact_mobileaddressComplement
synchroteam_create_equipment
Create equipment
WRITE: create a new piece of equipment under a site or a customer (give exactly one of site or customer; both is refused). If myId already exists nothing is created and an error is returned. POST /equipment/send.
Parametersnamerequiredsitemy_idcustomer
synchroteam_create_job
Create job
WRITE: create a new job for a customer (status created, not yet scheduled; use synchroteam_schedule_job to assign a technician and time). The customer is required (id, myId or exact name); site, equipment and job type are optional. If myId already exists nothing is created and an error is returned. Synchroteam may send the account's 'job created' notifications (email/SMS/webhook, possibly to the customer), as configured. POST /job/send.
Parameterssitetypemy_idskillsaddresscustomerrequiredpriorityequipmentdescriptioncontact_emailcontact_phonecontact_mobile+3 more
synchroteam_schedule_job
Schedule job
WRITE: schedule a job for a technician between two times (also re-schedules a scheduled or paused job). Synchroteam may notify technicians and/or customers (email/SMS/webhook) as configured in the account's notification settings (SMS uses the account's paid credits). Identify the job by exactly one of id, my_id or num. POST /job/schedule.
Parametersidnummy_idtechnicianrequiredscheduled_endrequiredscheduled_startrequiredother_technician_logins
synchroteam_start_job
Start job
WRITE: mark a job as started (status started, actual start now). If the job's technician already has another started job, Synchroteam pauses that one. Starting may trigger the account's 'job started' notifications (email/SMS/webhook to managers, technicians or the customer). Identify the job by exactly one of id, my_id or num. POST /job/start.
Parametersidnummy_id
synchroteam_complete_job
Complete job
WRITE: mark a job as completed, optionally with the real start and end times (give actual_start and actual_end together: Synchroteam may refuse the call with only one of them). Completing may trigger the account's 'job completed' notifications (email/SMS/webhook to managers, technicians or the customer), as configured in Synchroteam. Identify the job by exactly one of id, my_id or num. POST /job/complete.
Parametersidnummy_idactual_endactual_start