Skip to main content
Servicem8 logo
  • Category: scheduling & booking
  • Auth: OAUTH2
  • Composio-managed OAuth available? Yes
  • Tools: 61
  • Triggers: 0
  • Slug: SERVICEM8
  • Version: 20261103_00

Tools

Slug: SERVICEM8_CREATE_CLIENTCreate a ServiceM8 client company and retrieve its saved record. The client may be created even if the subsequent retrieval fails.

Input Parameters

string
required
Company or client name
string
UUID to assign to the new client record
array
Badge UUIDs to associate with the client
string
Complete company address
string
Company website
string
Australian Business Number
string
Fax number
string
City or suburb
string
State, territory, or province
string
Payment terms
string
UUID of the tax rate associated with the client
string
Street address
string
Country
string
Complete billing address
integer
Deposit percentage
string
Postal or ZIP code
string
Contact name for billing correspondence
string
UUID of the parent company, or blank for a head office

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICEM8_CREATE_COMPANY_CONTACTCreate a contact for a ServiceM8 client company and return its UUID.

Input Parameters

string
Contact’s last name.
string
Contact type, such as BILLING or JOB.
string
Optional UUID for the new record. ServiceM8 generates one when omitted.
string
Email address used for contact communications.
string
Contact’s first name.
string
Contact’s primary phone number, including area or country code.
string
Contact’s mobile phone number, including area or country code.
string
UUID of the company this contact belongs to.
string ("0" | "1")
Provider string flag: 1 for the primary contact, otherwise 0.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICEM8_CREATE_JOB_ACTIVITYCreate a scheduled or recorded ServiceM8 job activity and return its UUID.

Input Parameters

string
Optional UUID for the new record. ServiceM8 generates one when omitted.
string
Scheduled end date and time of the activity.
string
UUID of the job this activity belongs to.
string
UUID of the staff member assigned to this activity.
string
Scheduled start date and time of the activity.
string
UUID of the material used to determine the activity cost.
string ("0" | "1")
Provider string flag indicating whether the assigned staff member has viewed this scheduled activity.
string
Deprecated timestamp when the activity was allocated.
string ("0" | "1")
Provider string flag indicating whether the activity was recorded after completion; it cannot be true when activity_was_scheduled is true.
string ("0" | "1")
Provider string flag indicating whether the activity was automated.
string ("0" | "1")
Provider string flag indicating whether the activity was scheduled in advance; it cannot be true when activity_was_recorded is true.
integer
Estimated travel time to the activity location in seconds.
string
Deprecated UUID of the staff member who allocated the activity.
string
Date and time the assigned staff member first viewed the activity, in YYYY-MM-DD HH:MM:SS format.
integer
Estimated travel distance to the activity location in meters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICEM8_CREATE_JOB_CHECKLISTCreate a ServiceM8 job checklist item and return its UUID.

Input Parameters

string
Name or description displayed for the checklist item.
string
Optional UUID for the new record. ServiceM8 generates one when omitted.
string
UUID of the job this checklist item belongs to.
string ("Todo" | "Asset" | "Photo" | "Form" | "Document")
Checklist item type. ServiceM8 defaults this to ‘Todo’ when omitted.
integer
Display order; lower values appear first.
string
Section or category under which the checklist item is grouped.
string
Additional settings for an absolute or relative date-time reminder.
string ("" | "CHECK_IN" | "NAVIGATE" | "CHECK_OUT" | "ABSOLUTE_DATETIME" | "RELATIVE_DATETIME")
Event or date calculation that triggers the reminder; empty means none.
string
Type of object related to this checklist item, such as ‘Form’.
string
Completion date and time. Empty or ‘0000-00-00 00:00:00’ means not completed.
string
UUID of the object related to this checklist item.
array
Staff UUIDs assigned to the item; ServiceM8 currently allows at most one.
string
UUID of the completing staff member, or empty when not completed.
string
Type of object that completes this checklist item.
string
UUID of the object that completes this checklist item.
string
UUID of the job check-in during which the item was completed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICEM8_CREATE_JOB_CONTACTAdd a contact to a ServiceM8 job and return its created UUID.

Input Parameters

string
Last name of the job contact.
string ("JOB" | "Job Contact" | "BILLING" | "Billing Contact" | "Property Manager")
Contact relationship type: JOB, BILLING, or Property Manager.
string
Optional UUID for the new record. ServiceM8 generates one when omitted.
string
Email address used for job-related communications.
string
First name of the job contact.
string
Landline or office phone number of the job contact.
string
Mobile phone number of the job contact.
string
UUID of the valid job this contact is associated with.
string
Deprecated provider field indicating the primary contact.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICEM8_CREATE_JOB_MATERIALAdd a material line to a ServiceM8 job and return its created UUID.

Input Parameters

string
Material cost excluding tax, represented as a string.
string
Material name displayed on invoices and quotes.
string
Optional UUID for the new record. ServiceM8 generates one when omitted.
string
Unit price excluding tax, represented as a string.
string
UUID of the job this material line is associated with.
string
required
Quantity of the material used on the job.
string
Display order for the material line, represented as a string.
string
UUID of the catalog material this line is based on.
string
UUID of the tax rate applied to this material line.
string
Material cost displayed as tax-inclusive or tax-exclusive, represented as a string.
string
Unit price displayed on invoices and quotes, represented as a string.
string
UUID of the job material bundle containing this line.
boolean
Whether displayed_amount includes tax.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICEM8_CREATE_JOB_NOTECreate a new job note in ServiceM8. Requires the job’s UUID (related_object_uuid) and the note content. Returns the UUID of the created note record. Use this to add comments, updates, or action items to a specific job.

Input Parameters

string
required
Content of the note.
string
Unique identifier for this note record. If omitted, a UUID will be generated.
integer
Record active flag: 1 = active (default), 0 = deleted.
string
Timestamp when the note was created (format: YYYY-MM-DD HH:MM:SS). Server sets automatically if omitted.
Type of the related object. Defaults to ‘job’ for job notes. Other possible values may include ‘company’.
string
Optional follow-up action required description.
UUID of the related job.
string
UUID of staff member who completed the required action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICEM8_CREATE_JOB_PAYMENTTool to create a new job payment in ServiceM8. Use when you have collected payment details and need to record payment against a job. Example: “Create a 100.00 cash payment for job 123e4567-e89b-12d3-a456-426614174000 at 2023-01-01 13:00:00.”

Input Parameters

string
Additional notes or comments regarding the payment.
string
Optional UUID for the payment record. If omitted, a UUID will be auto-generated by the server.
integer
Record active flag: 1 = active (default), 0 = archived/deleted.
string
required
Amount of the payment as a decimal string (e.g., ‘100.00’, ‘50.50’). Use string format to preserve decimal precision.
string
required
Payment method used. Common values: ‘cash’, ‘credit_card’, ‘eftpos’, ‘cheque’, ‘bank_transfer’, ‘online’.
string
required
UUID of the job to record the payment against. Obtain this from list_all_jobs or create_job actions.
string
Timestamp of last edit in ‘YYYY-MM-DD HH:MM:SS’ format. Usually auto-set by the server if omitted.
string
required
Timestamp when the payment was received in ‘YYYY-MM-DD HH:MM:SS’ format.
integer
Deposit flag: 1 = this payment is a deposit, 0 = regular payment (default if omitted).
string
UUID of any attachment (e.g., receipt image) related to the payment.
string
UUID of the staff member who recorded/processed the payment. Obtain from staff endpoints. If omitted, may default to the authenticated user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICEM8_CREATE_JOBSCreate a new ServiceM8 job and retrieve its saved record. The job may be created even if the subsequent retrieval fails.

Input Parameters

string
Date the job is scheduled or created (YYYY-MM-DD).
integer
Active flag (1 = active, 0 = deleted). Defaults to 1.
array
List of badge UUIDs to apply to this job.
string ("Quote" | "Work Order" | "Unsuccessful" | "Completed")
required
Current status of the job. Controls dispatch board placement.
string
UUID of the queue to assign this job to.
string
required
Physical address where the job is to be performed.
string
UUID of the customer/company associated with this job.
string
UUID of the job category.
string
Brief description of the work to be done.
string
UUID of the staff member creating this job.
string
Client purchase order reference number.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICEM8_CREATE_MATERIALCreate a ServiceM8 material catalog record and return its UUID.

Input Parameters

string
Purchase cost of the material.
string
required
Name of the material, product, or labour rate.
string
Optional UUID for the new record. ServiceM8 generates one when omitted.
string
Selling price of the material.
string
UPC, EAN, or other barcode for the material.
string
Unique item number for the material, up to 30 characters.
string
UUID of the default tax rate for the material.
string
Description of the material.
string
Current quantity of the material in stock.
integer ("0" | "1")
Whether inventory tracking is enabled: 1 for yes, 0 for no.
integer ("0" | "1")
Whether price and cost include tax: 1 for yes, 0 for no.
string
Provider value controlling use of the description for invoicing.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICEM8_CREATE_TASKCreate a ServiceM8 task, optionally related to another ServiceM8 record.

Input Parameters

string
required
Task title.
string
Caller-provided UUID for the task. If omitted, ServiceM8 generates one.
string
Date by which the task should be completed, in YYYY-MM-DD format.
string
Task creation timestamp in YYYY-MM-DD HH:MM:SS format.
string
Instructions, details, or other notes for completing the task.
string ("0" | "1")
Completion flag: ‘0’ for pending or ‘1’ for complete.
ServiceM8 object class related to the task, such as ‘job’ or ‘client’. Supply together with related_object_uuid.
string
Completion timestamp in YYYY-MM-DD HH:MM:SS format.
UUID of the related ServiceM8 record. Supply together with related_object.
string
UUID of the staff member creating the task.
string
UUID of the staff member assigned to complete the task.
string
UUID of the staff member who completed the task.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICEM8_DELETE_CUSTOM_FIELDDelete a custom field in ServiceM8 by its UUID. Use this when you need to permanently remove a custom field definition from the system. This will remove the custom field and any associated data.

Input Parameters

string
required
The UUID of the custom field to delete. Must be a valid UUID string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICEM8_DELETE_JOB_ACTIVITYArchive a ServiceM8 job activity by UUID. ServiceM8 deletion is reversible: it sets the activity’s active field to 0, hiding the record in the UI while leaving it accessible through the API. Restore the activity by updating active to 1.

Input Parameters

string
required
UUID of the job activity to archive (soft-delete).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICEM8_DELETE_JOB_NOTEDeletes (archives) a job note in ServiceM8 by its UUID. Use this tool when you need to remove a note from a job’s diary. In ServiceM8, deletion is a soft-delete: the note is archived (active=0) rather than permanently removed, and can be restored later if needed. Prerequisites: You need the note’s UUID, which can be obtained from the ‘List All Job Notes’ or ‘Retrieve Job Note’ actions.

Input Parameters

string
required
UUID of the job note to delete. Example: ‘123e4567-e89b-12d3-a456-426614174000’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICEM8_DELETE_JOB_PAYMENTArchives (soft-deletes) a job payment record in ServiceM8 by its UUID. In ServiceM8, records are never permanently deleted. Instead, deletion sets the record’s ‘active’ field to 0, which hides it from the UI but keeps it accessible via the API. Archived records can be restored by setting their ‘active’ field back to 1. Use this tool when you need to remove a payment record from active use, such as when a payment was recorded in error or needs to be voided. Requires the ‘manage_job_payments’ OAuth scope.

Input Parameters

string
required
The UUID of the job payment to delete (archive). In ServiceM8, deletion is a soft delete that sets the record’s active field to 0, hiding it from the UI but keeping it accessible via API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICEM8_LIST_ALL_ASSETSTool to list all ServiceM8 assets. Use when you need a comprehensive asset registry, including custom fields, for inventory or reporting.

Input Parameters

string
OData-style filter expression to narrow down assets. Supported operators: eq (equal), ne (not equal), gt (greater than), lt (less than). Multiple conditions can be combined with ‘and’. Examples: ‘active eq 1’, ‘name eq ‘Pump Model X”. String values must be wrapped in single quotes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICEM8_LIST_ALL_CLIENTSTool to list all ServiceM8 clients. Use when you need a complete set of customer records for integrations or reporting.

Input Parameters

string
OData-style filter expression using $filter syntax. Supported operators: eq (equal), ne (not equal), gt (greater than), lt (less than). Combine conditions with ‘and’ (max 10 conditions). Examples: “active eq 1”, “name eq ‘Acme Corp’”, “create_date gt ‘2024-01-01’”. Note: ge/le operators are not supported.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICEM8_LIST_ALL_DOCUMENT_TEMPLATESTool to list document templates. Use when you need to retrieve available template UUIDs and names before generating job documents.

Input Parameters

string
Pagination cursor. Use ‘-1’ for the first page. For subsequent pages, use the value from the ‘x-next-cursor’ response header. If omitted, returns all templates.
string
OData-style filter expression to narrow document templates. Examples: ‘name eq “Invoice”’, ‘active eq 1’, ‘template_type eq “Quote”’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICEM8_LIST_ALL_FORMSList ServiceM8 form templates, optionally using an OData-style filter to narrow the results.

Input Parameters

string
OData-style filter expression to narrow down forms. Supported operators: eq (equals), ne (not equals), gt (greater than), lt (less than). Combine up to 10 conditions with ‘and’. String values must use single quotes. Examples: “active eq 1”, “name eq ‘Safety Checklist’”.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICEM8_LIST_ALL_JOB_NOTESList all job notes from ServiceM8. Use this tool to: - Retrieve all notes across all jobs (no filter) - Get notes for a specific job using filter: “related_object_uuid eq ‘<job_uuid>’” - Filter by active status: “active eq 1” for active notes only The response contains a list of note records with their content, timestamps, and associated job UUIDs. For large result sets, use cursor-based pagination: pass cursor=’-1’ for the first page, then use the ‘next_cursor’ value from each response to fetch subsequent pages. Each page returns up to 5,000 records.

Input Parameters

string
Cursor for pagination. Use ‘-1’ for the first page. For subsequent pages, use the ‘next_cursor’ value from the previous response. Each page returns up to 5,000 records.
string
OData filter expression to filter notes. Common filters include: ‘related_object_uuid eq <job_uuid>’ to get notes for a specific job, ‘active eq 1’ for active notes only. Use actual API field names (e.g., related_object_uuid, not job_uuid).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICEM8_LIST_ALL_JOB_QUEUESList all job queues in ServiceM8. Job queues are virtual folders for organizing jobs on hold. Use this to fetch available queues before assigning jobs to a queue, or to check queue configurations. Returns both regular queues (for jobs waiting on external actions) and assignable queues (for staff assignments).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICEM8_LIST_ALL_JOBSTool to list all jobs. Use when you need to fetch all job records from your ServiceM8 account.

Input Parameters

string
OData-style filter expression to narrow down jobs. Supported operators: eq (equals), ne (not equals), gt (greater than), lt (less than). Combine up to 10 conditions with ‘and’. String values must use single quotes. Examples: “status eq ‘Completed’”, “status eq ‘Work Order’ and active eq 1”, “date gt ‘2024-01-01’”.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICEM8_LIST_ALL_LOCATIONSLists all ServiceM8 locations. Use to fetch configured service areas, office locations, or warehouses for job assignments, mapping, or reporting.

Input Parameters

string
Optional filter expression to narrow down locations using ServiceM8 filtering syntax (e.g., ‘active eq 1’). See ServiceM8 filtering docs for syntax details.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICEM8_LIST_ALL_MATERIALSList ServiceM8 materials, including products, labour rates and inventory items, with optional filtering; requires the ‘read_inventory’ OAuth scope. Numeric zero active flags are returned as active.

Input Parameters

string
Filter expression using ServiceM8 filtering syntax to narrow down results. Examples: ‘active eq 1’ for active materials only, ‘name eq “Labour”’ for materials with specific name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICEM8_LIST_ALL_TASKSRetrieves all tasks from a ServiceM8 account with optional filtering and cursor-based pagination. Use this to fetch task records, track task assignments, monitor completion status, or sync task data. Requires ‘read_tasks’ OAuth scope.

Input Parameters

string
Cursor for pagination. Use ‘-1’ to start from the beginning. For subsequent pages, use the ‘next_cursor’ value from the previous response. Each page returns up to 5000 records.
string
OData-style filter expression to narrow results. Supported operators: eq (equal), ne (not equal), gt (greater than), lt (less than). String values must use single quotes. Combine up to 10 conditions with ‘and’. Example: “active eq 1 and job_uuid eq ‘abc-123‘“

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICEM8_LIST_ATTACHMENTSList ServiceM8 attachment metadata with filtering and cursor pagination.

Input Parameters

string
Pagination cursor. Use ‘-1’ for the first page, then pass the next_cursor returned by the previous call.
string
Filter records using ServiceM8 public field names and the eq, ne, gt, or lt operators. Combine up to 10 conditions with ‘and’ and enclose string values in single quotes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICEM8_LIST_COMPANY_CONTACTSList company contacts, optionally narrowed by an OData filter.

Input Parameters

string
OData filter using public API field names and eq, ne, gt, or lt. Combine up to 10 conditions with ‘and’ and quote string values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICEM8_LIST_FORM_RESPONSESList submitted ServiceM8 form responses with filtering and pagination.

Input Parameters

string
Pagination cursor. Use ‘-1’ for the first page, then pass the next_cursor returned by the previous call.
string
Filter records using ServiceM8 public field names and the eq, ne, gt, or lt operators. Combine up to 10 conditions with ‘and’ and enclose string values in single quotes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICEM8_LIST_JOB_ACTIVITIESList and filter ServiceM8 job activities with cursor pagination.

Input Parameters

string
Pagination cursor. Use ‘-1’ for the first page, then pass the next_cursor returned by the previous call.
string
Filter records using ServiceM8 public field names and the eq, ne, gt, or lt operators. Combine up to 10 conditions with ‘and’ and enclose string values in single quotes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICEM8_LIST_JOB_ALLOCATIONSList ServiceM8 job allocations, optionally filtered by public fields.

Input Parameters

string
OData filter using public API field names and eq, ne, gt, or lt. Combine up to 10 conditions with ‘and’ and quote string values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICEM8_LIST_JOB_CATEGORIESList job categories, optionally narrowed by an OData filter.

Input Parameters

string
OData filter using public API field names and eq, ne, gt, or lt. Combine up to 10 conditions with ‘and’ and quote string values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICEM8_LIST_JOB_CHECKLISTSList ServiceM8 job checklist items with filtering and cursor pagination.

Input Parameters

string
Pagination cursor. Use ‘-1’ for the first page, then pass the next_cursor returned by the previous call.
string
Filter records using ServiceM8 public field names and the eq, ne, gt, or lt operators. Combine up to 10 conditions with ‘and’ and enclose string values in single quotes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICEM8_LIST_JOB_CONTACTSList contacts linked to ServiceM8 jobs, with filtering and cursor pagination.

Input Parameters

string
Pagination cursor. Use ‘-1’ for the first page, then pass the next_cursor returned by the previous call.
string
Filter records using ServiceM8 public field names and the eq, ne, gt, or lt operators. Combine up to 10 conditions with ‘and’ and enclose string values in single quotes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICEM8_LIST_JOB_MATERIALSList material assignments on ServiceM8 jobs.

Input Parameters

string
Continuation cursor. Pass the next_cursor from a previous response; use ‘-1’ to begin explicit cursor pagination.
string
ServiceM8 filter expression. Supported operators are eq, ne, gt, and lt; strings use single quotes and up to 10 conditions may be joined with ‘and’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICEM8_LIST_JOB_PAYMENTSList, filter, and cursor-page ServiceM8 job payments.

Input Parameters

string
Pagination cursor. Use ‘-1’ for the first page, then pass the next_cursor returned by the previous call.
string
Filter records using ServiceM8 public field names and the eq, ne, gt, or lt operators. Combine up to 10 conditions with ‘and’ and enclose string values in single quotes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICEM8_LIST_STAFFList staff members, optionally narrowed by an OData filter.

Input Parameters

string
OData filter using public API field names and eq, ne, gt, or lt. Combine up to 10 conditions with ‘and’ and quote string values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICEM8_LIST_VENDORSList vendor accounts, optionally narrowed by an OData filter.

Input Parameters

string
OData filter using public API field names and eq, ne, gt, or lt. Combine up to 10 conditions with ‘and’ and quote string values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICEM8_RETRIEVE_CLIENTTool to retrieve details of a specific client by its UUID. Use after confirming the client’s UUID is valid.

Input Parameters

string
required
UUID of the company (client) to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICEM8_RETRIEVE_COMPANY_CONTACTRetrieve one ServiceM8 company contact by its UUID.

Input Parameters

string
required
UUID of the company contact to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICEM8_RETRIEVE_FORMRetrieve details of a specific form template by its UUID. Use this tool when you have a form UUID and need to fetch its metadata, such as form name, description, and status. Requires the Forms add-on to be enabled in ServiceM8.

Input Parameters

string
required
The unique identifier (UUID) of the form to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICEM8_RETRIEVE_JOBTool to retrieve details of a specific job by its UUID. Use when you have the Job UUID and need its full record.

Input Parameters

string
required
The UUID of the job to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICEM8_RETRIEVE_JOB_ACTIVITYTool to retrieve details of a specific job activity by its UUID. Use when you have the job activity UUID and need its full details.

Input Parameters

string
required
UUID of the ServiceM8 job activity to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICEM8_RETRIEVE_JOB_CONTACTRetrieve one ServiceM8 job contact by its UUID.

Input Parameters

string
required
UUID of the job contact to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICEM8_RETRIEVE_JOB_MATERIALRetrieve one ServiceM8 job material line item by its UUID.

Input Parameters

string
required
UUID of the job material line item to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICEM8_RETRIEVE_JOB_NOTERetrieve the full details of a specific job note by its UUID. Use this action when you have a note UUID (e.g., from listing job notes) and need to view its complete record including content, timestamps, and the associated job reference.

Input Parameters

string
required
UUID of the job note to retrieve. You can obtain this from the ‘List All Job Notes’ action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICEM8_RETRIEVE_JOB_PAYMENTRetrieve a specific job payment record from ServiceM8 by its UUID. Use this tool when you need to: - Get full details of a specific payment (amount, method, timestamp, notes) - Check if a payment is a deposit or regular payment - View which staff member processed a payment - Verify payment information for a job Prerequisites: You need the job payment UUID, which can be obtained from the ‘List All Job Payments’ action or from creating a new job payment.

Input Parameters

string
required
The unique identifier (UUID) of the job payment record to retrieve. This is a 36-character UUID string (e.g., ‘550e8400-e29b-41d4-a716-446655440000’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICEM8_RETRIEVE_JOB_QUEUETool to retrieve details of a specific job queue by its UUID. Use when you need full queue metadata before dispatching work.

Input Parameters

string
required
UUID of the job queue to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICEM8_RETRIEVE_LOCATIONRetrieve a ServiceM8 location by UUID, including available address, geographic coordinates, contact phone number, and active status.

Input Parameters

string
required
The unique identifier (UUID) of the location to retrieve. Must be a valid 36-character UUID string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICEM8_RETRIEVE_MATERIALRetrieve detailed information about a specific material/product/service by its UUID. Returns pricing, inventory levels, tax settings, and identification details. Use this when you have a material UUID from a job or list operation and need complete details like current stock levels or pricing information.

Input Parameters

string
required
UUID of the material to retrieve. Obtain this from the ‘List All Materials’ action or from job material records.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICEM8_RETRIEVE_STAFF_MEMBERTool to retrieve details of a specific staff member by their UUID. Use when you need up-to-date staff information given a known staff UUID.

Input Parameters

string
required
The unique identifier (UUID) of the staff member to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICEM8_UPDATE_CLIENTUpdate a ServiceM8 client by UUID, requiring the client name, and retrieve the saved record. The update may succeed even if the subsequent retrieval fails.

Input Parameters

string
required
Updated company name
string
required
UUID of the existing client to update; used in the request path
array
Badge UUIDs to associate with the client
string
Updated complete company address
string
Updated company website
string
Optional UUID to send in the update body as the client’s uuid field
string
Updated Australian Business Number
string
Updated fax number
string
Updated city or suburb
string
Updated state, territory, or province
string
Updated payment terms
string
UUID of the tax rate associated with the client
string
Updated street address
string
Updated country
string
Updated complete billing address
integer
Updated deposit percentage
string
Updated postal or ZIP code
string
Updated billing attention name
string
UUID of the parent Company, or blank for a Head Office

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICEM8_UPDATE_COMPANY_CONTACTPartially update a company contact by UUID and retrieve the saved record. The update may succeed even if the subsequent retrieval fails.

Input Parameters

string
Updated last name.
string
Updated contact type, such as BILLING or JOB.
string
required
UUID of the existing company contact to update; used in the request path.
string
Updated email address.
string
Updated first name.
string
Updated phone number.
string
Updated mobile number.
string
Optional UUID to send in the update body as the contact’s uuid field.
string
UUID of the company this contact belongs to.
string
Provider string flag: 1 for the primary contact and 0 otherwise.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICEM8_UPDATE_JOBUpdate a ServiceM8 job by UUID, requiring a job status, and retrieve the saved record. The update may succeed even if the subsequent retrieval fails.

Input Parameters

string
Updated job date in YYYY-MM-DD format
string
required
UUID of the existing job to update; used in the request path
array
Badge UUIDs to associate with the job
string ("Quote" | "Work Order" | "Unsuccessful" | "Completed")
required
Updated job status
string
UUID of the queue assigned to the job
string
Updated timestamp when the job became a quote
integer
Whether a quote has been sent: 1 or 0
string
Updated physical job address
string
UUID of the client associated with the job
string
Updated invoice issue timestamp
integer
Whether an invoice has been sent: 1 or 0
string
UUID of the job category
string
Updated billing address
string
Updated completion timestamp in YYYY-MM-DD HH:MM:SS format
string
Updated description of the work to perform
string
Updated timestamp when the job became a work order
integer
Whether full payment was received: 1 or 0
integer
Whether the job has been exported to accounting: 1 or 0
string
Updated queue expiry timestamp
string
Updated timestamp when the job became unsuccessful
string
UUID of the staff member recorded as creating the job
string
Updated client purchase order reference
string
Updated description of work completed
string
UUID of the staff member assigned to the queued job

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICEM8_UPDATE_JOB_ACTIVITYUpdate a known job activity and return it. Provide at least one field to update.

Input Parameters

string
required
UUID of the job activity to update.
string
Scheduled end date and time in YYYY-MM-DD HH:MM:SS format.
string
UUID of the job this activity belongs to.
string
UUID of the staff member assigned to this activity.
string
Scheduled start date and time in YYYY-MM-DD HH:MM:SS format.
string
UUID of the material associated with this activity.
string
Flag indicating whether the assigned staff member opened it.
string
Flag indicating whether the activity was recorded.
string
Flag indicating whether the activity was automated.
string
Flag indicating whether the activity was scheduled.
integer
Estimated travel time to the activity in seconds.
string
Date and time the activity was first opened, in YYYY-MM-DD HH:MM:SS format.
integer
Estimated travel distance to the activity in meters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICEM8_UPDATE_JOB_CONTACTUpdate selected fields on a ServiceM8 job contact and return the saved record.

Input Parameters

string
Last name of the job contact.
string ("JOB" | "Job Contact" | "BILLING" | "Billing Contact" | "Property Manager")
Contact role: JOB or Job Contact, BILLING or Billing Contact, or Property Manager.
string
required
UUID of the job contact to update.
string
Email address of the job contact.
string
First name of the job contact.
string
Landline or office phone number of the job contact.
string
Mobile phone number of the job contact.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICEM8_UPDATE_JOB_MATERIALUpdate an existing material line assigned to a ServiceM8 job.

Input Parameters

string
Material cost excluding tax, represented as a string.
string
Material name displayed on invoices and quotes.
string
required
UUID of the job material to update.
string
Unit price excluding tax, represented as a string.
string
UUID of the job this material line is associated with.
string
required
Quantity of the material used on the job. ServiceM8 requires this field for updates.
string
Display order for the material line, represented as a string.
string
UUID of the catalog material this line is based on.
string
UUID of the tax rate applied to this material line.
string
Displayed material cost, represented as a string.
string
Unit price displayed on invoices and quotes, represented as a string.
string
UUID of the job material bundle containing this line, or an empty string to remove it from a bundle.
string
Provider string flag indicating whether displayed_amount includes tax.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICEM8_UPDATE_JOB_NOTETool to update details of an existing job note. Use when modifying a note after its creation.

Input Parameters

string
New content for the job note
string
required
UUID of the job note to update
integer
Active flag: 1=active, 0=archived
string
Timestamp when the note was last edited in ‘YYYY-MM-DD HH:MM:SS’ format

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICEM8_UPDATE_JOB_PAYMENTUpdate an existing job payment record in ServiceM8. Use this to modify payment details such as amount, method, note, or status. Requires the payment UUID and at least one field to update.

Input Parameters

string
Note or memo for the payment
string
required
UUID of the job payment record to update (required)
integer
Active status: 1=active, 0=archived/deleted
string
New payment amount as a decimal string (e.g., ‘150.00’)
string
Payment method: ‘cash’, ‘credit_card’, ‘eftpos’, ‘cheque’, ‘direct_deposit’, or ‘other’
string
Payment date/time in ‘YYYY-MM-DD HH:MM:SS’ format
integer
Whether this is a deposit: 1=deposit, 0=regular payment
string
UUID of an attachment (e.g., receipt image) linked to this payment
string
UUID of the staff member who recorded or updated the payment

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICEM8_UPDATE_JOB_QUEUEUpdate a ServiceM8 job queue and return its saved provider record.

Input Parameters

string
Updated job queue name
string
required
UUID of the existing job queue to update; used in the request path
string
Updated semicolon-delimited list of subscribed staff UUIDs
integer
Updated default timeframe in days
integer
Whether jobs require assignment: 1 for yes, 0 for no

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICEM8_UPDATE_MATERIALUpdate an inventory material by UUID, requiring its name, and return its saved provider record.

Input Parameters

string
Updated purchase or internal cost as a decimal string
string
required
Updated material name
string
required
UUID of the existing material to update; used in the request path
string
Updated selling price as a decimal string
string
Updated barcode
string
Updated item or SKU number
string
UUID of the default tax rate for the material
string
Updated material description
number
Updated inventory quantity in stock
integer
Whether inventory tracking is enabled: 1 for yes, 0 for no
integer
Whether the selling price includes tax: 1 for yes, 0 for no
string
Updated description setting used for invoicing

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SERVICEM8_UPDATE_TASKUpdate a ServiceM8 task by UUID, requiring its name, and return the saved record.

Input Parameters

string
required
New task title.
string
required
UUID of the task to update.
string
New due date in YYYY-MM-DD format.
string
Task creation timestamp in YYYY-MM-DD HH:MM:SS format.
string
New instructions, details, or notes for the task.
string ("0" | "1")
New completion flag: ‘0’ for pending or ‘1’ for complete.
New related ServiceM8 object class, such as ‘job’ or ‘client’.
string
New completion timestamp in YYYY-MM-DD HH:MM:SS format.
UUID of the new related ServiceM8 record.
string
UUID of the staff member who created the task.
string
UUID of the staff member newly assigned to complete the task.
string
UUID of the staff member who completed the task.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not