ServiceM8
ProductivityAPI keyOAuth 2.0
Manage field service jobs, clients, contacts, notes, schedule and job materials in ServiceM8.
16 actions
| Action | Effect | Data handled | Scope |
|---|---|---|---|
| servicem8_list_jobsLists jobs, up to 1000 per page, filtered by status, client or an OData filter; nextCursor fetches the next page | read | Personal data | read_jobs |
| servicem8_get_jobReturns one job with its status, address, description, dates and invoice amounts | read | Personal data | read_jobs |
| servicem8_create_jobCreates a quote or work order for a client with its address and description, returning the new uuid | write | Personal data | create_jobs |
| servicem8_update_jobChanges the status, client, address, description or other fields of a job; fields left out stay as they are | write | Personal data | manage_jobs |
| servicem8_list_clientsLists clients (companies and individuals), up to 1000 per page, optionally with an OData filter; nextCursor fetches the next page | read | Personal data | read_customers |
| servicem8_get_clientReturns one client with address, billing details and payment terms | read | Personal data | read_customers |
| servicem8_create_clientCreates a client, a company or an individual, with an address and billing details, returning the new uuid | write | Personal data | manage_customers |
| servicem8_list_client_contactsLists client contacts with names, phones and emails, optionally with an OData filter such as company_uuid eq '...' | read | Personal data | read_customer_contacts |
| servicem8_create_client_contactAdds a contact person to a client, returning the new uuid | write | Personal data | manage_customer_contacts |
| servicem8_add_job_noteAdds a note to a job | write | Personal data | publish_job_notes |
| servicem8_list_notesLists job notes, optionally with an OData filter such as related_object_uuid eq '...' | read | Personal data | read_job_notes |
| servicem8_schedule_jobBooks a staff member onto a job for a time slot on the schedule, returning the new activity uuid | write | General | manage_schedule |
| servicem8_list_job_activitiesLists scheduled and recorded job activities (bookings and time on site), optionally with an OData filter such as job_uuid eq '...' | read | General | read_schedule |
| servicem8_list_staffLists staff members with their uuids, names, emails and mobiles | read | Personal data | read_staff |
| servicem8_list_materialsLists the materials and services in the price list with item numbers, prices and costs | read | General | read_inventory |
| servicem8_add_job_materialAdds a material or service line to a job, from the price list or as a custom line, returning the new uuid | write | General | manage_job_materials |