Servicem8
servicem8ServiceM8 helps field service businesses schedule jobs, send quotes, and manage invoices, offering staff mobile apps and real-time job status tracking
Acciones disponibles (28)
Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.
ServiceM8 Create Job NoteSERVICEM8_CREATE_JOB_NOTEAcciónTool to create a new job note in servicem8. use when you need to attach additional information to a specific job after obtaining its uuid.
SERVICEM8_CREATE_JOB_NOTEAcciónTool to create a new job note in servicem8. use when you need to attach additional information to a specific job after obtaining its uuid.
Parámetros de entrada
notestringObligatorioContent of the note.
uuidstringUnique identifier for this note record. If omitted, a UUID will be generated.
activeintegerRecord active flag: 1 = active (default), 0 = deleted.
create_datestringTimestamp when record was last modified (ISO 8601). Server overrides if omitted.
related_objectstringObligatorioType of the related object. Use 'job' for job notes.
action_requiredstringOptional follow-up action required description.
related_object_uuidstringObligatorioUUID of the related job.
action_completed_by_staff_uuidstringUUID of staff member who completed the required action.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
ServiceM8 Create Job PaymentSERVICEM8_CREATE_JOB_PAYMENTAcciónTool 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."
SERVICEM8_CREATE_JOB_PAYMENTAcciónTool 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."
Parámetros de entrada
notestringAdditional notes regarding the payment.
uuidstringOptional unique identifier for the job payment.
activeintegerObligatorioenum1 if the payment is active; 0 if archived.
01amountstringObligatorioAmount of the payment.
methodstringObligatorioPayment method used.
job_uuidstringObligatorioUUID of the associated job.
edit_datestringObligatorioTimestamp of last edit in 'YYYY-MM-DD HH:MM:SS' format.
timestampstringObligatorioTimestamp of the payment in 'YYYY-MM-DD HH:MM:SS' format.
is_depositintegerenum1 if this payment is a deposit; 0 otherwise.
01attachment_uuidstringUUID of any attachment related to the payment.
actioned_by_uuidstringObligatorioUUID of the staff member who actioned the payment.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create a new JobSERVICEM8_CREATE_JOBSAcciónTool to create a new job in servicem8. use when you have gathered all job details and need to push a record. example: "create a quote job for 123 main st with po #1234."
SERVICEM8_CREATE_JOBSAcciónTool to create a new job in servicem8. use when you have gathered all job details and need to push a record. example: "create a quote job for 123 main st with po #1234."
Parámetros de entrada
datestringDate the job is scheduled or created (YYYY-MM-DD).
activeintegerActive flag (1 = active, 0 = deleted). Defaults to 1.
badgesstring[]List of badge UUIDs to apply (comma-separated).
statusstringObligatorioenumCurrent status of the job. Controls dispatch board placement.
QuoteWork OrderUnsuccessfulCompletedqueue_uuidstringUUID of the queue to assign this job to.
job_addressstringObligatorioPhysical address where the job is to be performed.
company_uuidstringUUID of the customer/company associated with this job.
category_uuidstringUUID of the job category.
job_descriptionstringBrief description of the work to be done.
created_by_staff_uuidstringUUID of the staff member creating this job.
purchase_order_numberstringClient purchase order reference number.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete Job NoteSERVICEM8_DELETE_JOB_NOTEAcciónTool to delete a specific job note. use when you need to archive a note by its uuid.
SERVICEM8_DELETE_JOB_NOTEAcciónTool to delete a specific job note. use when you need to archive a note by its uuid.
Parámetros de entrada
uuidstringObligatorioUUID of the job note to delete. Example: '123e4567-e89b-12d3-a456-426614174000'
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
ServiceM8 Delete Job PaymentSERVICEM8_DELETE_JOB_PAYMENTAcciónTool to delete (archive) a specific job payment by its uuid. use when you need to archive a payment record.
SERVICEM8_DELETE_JOB_PAYMENTAcciónTool to delete (archive) a specific job payment by its uuid. use when you need to archive a payment record.
Parámetros de entrada
uuidstringObligatorioThe UUID of the job payment to delete (archive).
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List All AssetsSERVICEM8_LIST_ALL_ASSETSAcciónTool to list all servicem8 assets. use when you need a comprehensive asset registry, including custom fields, for inventory or reporting.
SERVICEM8_LIST_ALL_ASSETSAcciónTool to list all servicem8 assets. use when you need a comprehensive asset registry, including custom fields, for inventory or reporting.
Parámetros de entrada
filterstringFilter expression to narrow down assets; use ServiceM8 filtering syntax, e.g., 'active eq 1'.
Parámetros de salida
dataobject[]ObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List All ClientsSERVICEM8_LIST_ALL_CLIENTSAcciónTool to list all servicem8 clients. use when you need a complete set of customer records for integrations or reporting.
SERVICEM8_LIST_ALL_CLIENTSAcciónTool to list all servicem8 clients. use when you need a complete set of customer records for integrations or reporting.
Parámetros de entrada
filterstringFilter expression to narrow down clients; use ServiceM8 filtering syntax, e.g., 'active eq true'.
Parámetros de salida
dataobject[]ObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List All Document TemplatesSERVICEM8_LIST_ALL_DOCUMENT_TEMPLATESAcciónTool to list document templates. use when you need to retrieve available template uuids and names before generating job documents.
SERVICEM8_LIST_ALL_DOCUMENT_TEMPLATESAcciónTool to list document templates. use when you need to retrieve available template uuids and names before generating job documents.
Parámetros de entrada
limitintegerMaximum number of templates to return (must be ≥1).
filterstringFilter expression to narrow document templates; use ServiceM8 filtering syntax, e.g., 'name eq "Invoice"'.
offsetintegerNumber of templates to skip before returning results (must be ≥0).
Parámetros de salida
dataobject[]ObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List All FormsSERVICEM8_LIST_ALL_FORMSAcciónTool to list all servicem8 forms. use when you need to fetch available form templates with optional filters.
SERVICEM8_LIST_ALL_FORMSAcciónTool to list all servicem8 forms. use when you need to fetch available form templates with optional filters.
Parámetros de entrada
filterstringFilter expression to narrow down forms; use ServiceM8 filtering syntax, e.g., 'active eq true'.
Parámetros de salida
dataobject[]ObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List All Job NotesSERVICEM8_LIST_ALL_JOB_NOTESAcciónTool to list all job notes in servicem8. use when you need to fetch notes, optionally filtered or paginated.
SERVICEM8_LIST_ALL_JOB_NOTESAcciónTool to list all job notes in servicem8. use when you need to fetch notes, optionally filtered or paginated.
Parámetros de entrada
limitintegerMaximum number of notes to return (must be >=1).
filterstringServiceM8 OData filter expression; only one filter per request.
offsetintegerNumber of notes to skip (must be >=0).
Parámetros de salida
dataobject[]ObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List All Job QueuesSERVICEM8_LIST_ALL_JOB_QUEUESAcciónTool to list all job queues in servicem8. use when you need to fetch configured queues before dispatching jobs.
SERVICEM8_LIST_ALL_JOB_QUEUESAcciónTool to list all job queues in servicem8. use when you need to fetch configured queues before dispatching jobs.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobject[]ObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List All JobsSERVICEM8_LIST_ALL_JOBSAcciónTool to list all jobs. use when you need to fetch all job records from your servicem8 account.
SERVICEM8_LIST_ALL_JOBSAcciónTool to list all jobs. use when you need to fetch all job records from your servicem8 account.
Parámetros de entrada
filterstringFilter criteria to narrow down jobs. Use ServiceM8 filtering syntax, e.g. "status='Completed'".
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List All LocationsSERVICEM8_LIST_ALL_LOCATIONSAcciónTool to list all servicem8 locations. use when you need to fetch every configured location for assignments or mapping.
SERVICEM8_LIST_ALL_LOCATIONSAcciónTool to list all servicem8 locations. use when you need to fetch every configured location for assignments or mapping.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobject[]ObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List All MaterialsSERVICEM8_LIST_ALL_MATERIALSAcciónTool to list all materials. use when you need a full inventory dump after authenticating with read inventory scope.
SERVICEM8_LIST_ALL_MATERIALSAcciónTool to list all materials. use when you need a full inventory dump after authenticating with read inventory scope.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobject[]ObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List All TasksSERVICEM8_LIST_ALL_TASKSAcciónTool to list all tasks in a servicem8 account. use when you need to fetch task records, optionally filtered. requires 'read tasks' oauth scope.
SERVICEM8_LIST_ALL_TASKSAcciónTool to list all tasks in a servicem8 account. use when you need to fetch task records, optionally filtered. requires 'read tasks' oauth scope.
Parámetros de entrada
limitintegerMaximum number of tasks to return (must be ≥1).
filterstringFilter expression to narrow task results; use OData syntax, e.g., "completed eq false".
offsetintegerNumber of tasks to skip (must be ≥0).
Parámetros de salida
dataobject[]ObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Retrieve ServiceM8 ClientSERVICEM8_RETRIEVE_CLIENTAcciónTool to retrieve details of a specific client by its uuid. use after confirming the client's uuid is valid.
SERVICEM8_RETRIEVE_CLIENTAcciónTool to retrieve details of a specific client by its uuid. use after confirming the client's uuid is valid.
Parámetros de entrada
uuidstringObligatorioUUID of the company (client) to retrieve
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Retrieve FormSERVICEM8_RETRIEVE_FORMAcciónTool to retrieve details of a specific form by its uuid. use when you need up-to-date form metadata given a known form uuid.
SERVICEM8_RETRIEVE_FORMAcciónTool to retrieve details of a specific form by its uuid. use when you need up-to-date form metadata given a known form uuid.
Parámetros de entrada
uuidanyObligatoriouuidThe unique identifier (UUID) of the form to retrieve.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Retrieve JobSERVICEM8_RETRIEVE_JOBAcciónTool to retrieve details of a specific job by its uuid. use when you have the job uuid and need its full record.
SERVICEM8_RETRIEVE_JOBAcciónTool to retrieve details of a specific job by its uuid. use when you have the job uuid and need its full record.
Parámetros de entrada
uuidstringObligatorioThe UUID of the job to retrieve
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Retrieve Job ActivitySERVICEM8_RETRIEVE_JOB_ACTIVITYAcciónTool to retrieve details of a specific job activity by its uuid. use when you have the job activity uuid and need its full details.
SERVICEM8_RETRIEVE_JOB_ACTIVITYAcciónTool to retrieve details of a specific job activity by its uuid. use when you have the job activity uuid and need its full details.
Parámetros de entrada
uuidstringObligatorioUUID of the ServiceM8 job activity to retrieve
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Retrieve Job NoteSERVICEM8_RETRIEVE_JOB_NOTEAcciónTool to retrieve details of a specific job note by its uuid. use when you have the note uuid (e.g., after listing notes) and need its full record before processing or display.
SERVICEM8_RETRIEVE_JOB_NOTEAcciónTool to retrieve details of a specific job note by its uuid. use when you have the note uuid (e.g., after listing notes) and need its full record before processing or display.
Parámetros de entrada
uuidstringObligatorioUUID of the job note to retrieve.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Retrieve Job PaymentSERVICEM8_RETRIEVE_JOB_PAYMENTAcciónTool to retrieve details of a specific job payment by its uuid. use when you have the payment uuid and need its full record and metadata.
SERVICEM8_RETRIEVE_JOB_PAYMENTAcciónTool to retrieve details of a specific job payment by its uuid. use when you have the payment uuid and need its full record and metadata.
Parámetros de entrada
uuidstringObligatorioThe UUID of the job payment to retrieve.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Retrieve Job QueueSERVICEM8_RETRIEVE_JOB_QUEUEAcciónTool to retrieve details of a specific job queue by its uuid. use when you need full queue metadata before dispatching work.
SERVICEM8_RETRIEVE_JOB_QUEUEAcciónTool to retrieve details of a specific job queue by its uuid. use when you need full queue metadata before dispatching work.
Parámetros de entrada
uuidstringObligatorioUUID of the job queue to retrieve.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Retrieve LocationSERVICEM8_RETRIEVE_LOCATIONAcciónTool to retrieve details of a specific location by its uuid. use when you already have the location's uuid and need full location details.
SERVICEM8_RETRIEVE_LOCATIONAcciónTool to retrieve details of a specific location by its uuid. use when you already have the location's uuid and need full location details.
Parámetros de entrada
uuidanyObligatoriouuidUUID of the ServiceM8 location to retrieve.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Retrieve ServiceM8 MaterialSERVICEM8_RETRIEVE_MATERIALAcciónTool to retrieve details of a specific material by its uuid. use when you have a material uuid and need current inventory or pricing details.
SERVICEM8_RETRIEVE_MATERIALAcciónTool to retrieve details of a specific material by its uuid. use when you have a material uuid and need current inventory or pricing details.
Parámetros de entrada
uuidstringObligatorioUUID of the material to retrieve
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Retrieve Staff MemberSERVICEM8_RETRIEVE_STAFF_MEMBERAcciónTool 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.
SERVICEM8_RETRIEVE_STAFF_MEMBERAcciónTool 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.
Parámetros de entrada
uuidanyObligatoriouuidThe unique identifier (UUID) of the staff member to retrieve.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
ServiceM8 Create JobSERVICEM8_SERVICE_M8_CREATE_JOBAcciónTool to create a new job in servicem8. use when you have all job details and need to push a record into servicem8. example: "create a quote job for 123 main st with po #1234."
SERVICEM8_SERVICE_M8_CREATE_JOBAcciónTool to create a new job in servicem8. use when you have all job details and need to push a record into servicem8. example: "create a quote job for 123 main st with po #1234."
Parámetros de entrada
datestringDate the job is scheduled or created (YYYY-MM-DD).
activeintegerenumActive flag (1=active, 0=deleted). Defaults to 1.
01badgesstring[]List of badge UUIDs to apply (visual indicators on dispatch board).
statusstringObligatorioenumCurrent status of the job (controls dispatch board placement).
QuoteWork OrderUnsuccessfulCompletedqueue_uuidstringUUID of the queue to assign this job to.
job_addressstringObligatorioPhysical address where the job is to be performed.
company_uuidstringUUID of the customer/company associated with this job.
category_uuidstringUUID of the job category (e.g., Plumbing, Electrical).
job_descriptionstringBrief description of the work to be done.
created_by_staff_uuidstringUUID of the staff member creating this job.
purchase_order_numberstringClient purchase order reference number.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update a ServiceM8 Job NoteSERVICEM8_UPDATE_JOB_NOTEAcciónTool to update details of an existing job note. use when modifying a note after its creation.
SERVICEM8_UPDATE_JOB_NOTEAcciónTool to update details of an existing job note. use when modifying a note after its creation.
Parámetros de entrada
notestringNew content for the job note
uuidstringObligatorioUUID of the job note to update
activeintegerActive flag: 1=active, 0=archived
edit_datestringTimestamp when the note was last edited in 'YYYY-MM-DD HH:MM:SS' format
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
ServiceM8 Update Job PaymentSERVICEM8_UPDATE_JOB_PAYMENTAcciónTool to update details of an existing job payment. use after confirming the payment uuid and desired changes.
SERVICEM8_UPDATE_JOB_PAYMENTAcciónTool to update details of an existing job payment. use after confirming the payment uuid and desired changes.
Parámetros de entrada
notestringOptional note for the payment
uuidstringObligatorioUUID of the job payment to update
activeintegerActive flag: 1=active, 0=archived
amountstringObligatorioAmount of the payment
methodstringPayment method used, e.g., 'cash' or 'credit_card'
job_uuidstringObligatorioUUID of the associated job
edit_datestringLast edited timestamp in 'YYYY-MM-DD HH:MM:SS' format
timestampstringPayment timestamp in 'YYYY-MM-DD HH:MM:SS' format
is_depositintegerDeposit flag: 1=deposit, 0=not a deposit
attachment_uuidstringUUID of an attachment related to the payment
actioned_by_uuidstringUUID of the staff member who actioned the payment
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not