Servicem8

Learn how to use Servicem8 with Composio

Overview

SLUG

SERVICEM8

Description

ServiceM8 helps field service businesses schedule jobs, send quotes, and manage invoices, offering staff mobile apps and real-time job status tracking

Authentication Details

client_id
stringRequired
client_secret
stringRequired
full
stringDefaults to https://api.servicem8.comRequired
oauth_redirect_uri
stringDefaults to https://backend.composio.dev/api/v1/auth-apps/add
scopes
stringDefaults to staff_locations,staff_activity,publish_sms,publish_email,vendor,vendor_logo,vendor_email,read_locations,manage_locations,read_staff,manage_staff,read_customers,manage_customers,read_customer_contacts,manage_customer_contacts,read_jobs,manage_jobs,create_jobs,read_job_contacts,manage_job_contacts,read_job_materials,manage_job_materials,read_job_categories,manage_job_categories,read_job_queues,manage_job_queues,read_tasks,manage_tasks,read_schedule,manage_schedule,read_inventory,manage_inventory,read_job_notes,publish_job_notes,read_job_photos,publish_job_photos,read_job_attachments,publish_job_attachments,read_inbox,read_messages,manage_notifications,manage_templates,manage_badges,read_assets,manage_assets
bearer_token
string

Tools

SLUG: SERVICEM8_CREATE_JOBS

Tool 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."

Action Parameters

active
integerDefaults to 1
badges
array
category_uuid
string
company_uuid
string
created_by_staff_uuid
string
date
string
job_address
stringRequired
job_description
string
purchase_order_number
string
queue_uuid
string
status
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SERVICEM8_CREATE_JOB_NOTE

Tool to create a new job note in servicem8. use when you need to attach additional information to a specific job after obtaining its uuid.

Action Parameters

action_completed_by_staff_uuid
string
action_required
string
active
integerDefaults to 1
create_date
string
note
stringRequired
related_object
stringRequired
related_object_uuid
stringRequired
uuid
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SERVICEM8_CREATE_JOB_PAYMENT

Tool 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."

Action Parameters

actioned_by_uuid
stringRequired
active
integerRequired
amount
stringRequired
attachment_uuid
string
edit_date
stringRequired
is_deposit
integer
job_uuid
stringRequired
method
stringRequired
note
string
timestamp
stringRequired
uuid
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SERVICEM8_DELETE_JOB_NOTE

Tool to delete a specific job note. use when you need to archive a note by its uuid.

Action Parameters

uuid
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SERVICEM8_DELETE_JOB_PAYMENT

Tool to delete (archive) a specific job payment by its uuid. use when you need to archive a payment record.

Action Parameters

uuid
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SERVICEM8_LIST_ALL_ASSETS

Tool to list all servicem8 assets. use when you need a comprehensive asset registry, including custom fields, for inventory or reporting.

Action Parameters

filter
string

Action Response

data
arrayRequired
error
string
successful
booleanRequired

SLUG: SERVICEM8_LIST_ALL_CLIENTS

Tool to list all servicem8 clients. use when you need a complete set of customer records for integrations or reporting.

Action Parameters

filter
string

Action Response

data
arrayRequired
error
string
successful
booleanRequired

SLUG: SERVICEM8_LIST_ALL_DOCUMENT_TEMPLATES

Tool to list document templates. use when you need to retrieve available template uuids and names before generating job documents.

Action Parameters

filter
string
limit
integer
offset
integer

Action Response

data
arrayRequired
error
string
successful
booleanRequired

SLUG: SERVICEM8_LIST_ALL_FORMS

Tool to list all servicem8 forms. use when you need to fetch available form templates with optional filters.

Action Parameters

filter
string

Action Response

data
arrayRequired
error
string
successful
booleanRequired

SLUG: SERVICEM8_LIST_ALL_JOBS

Tool to list all jobs. use when you need to fetch all job records from your servicem8 account.

Action Parameters

filter
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SERVICEM8_LIST_ALL_JOB_NOTES

Tool to list all job notes in servicem8. use when you need to fetch notes, optionally filtered or paginated.

Action Parameters

filter
string
limit
integer
offset
integer

Action Response

data
arrayRequired
error
string
successful
booleanRequired

SLUG: SERVICEM8_LIST_ALL_JOB_QUEUES

Tool to list all job queues in servicem8. use when you need to fetch configured queues before dispatching jobs.

Action Parameters

Action Response

data
arrayRequired
error
string
successful
booleanRequired

SLUG: SERVICEM8_LIST_ALL_LOCATIONS

Tool to list all servicem8 locations. use when you need to fetch every configured location for assignments or mapping.

Action Parameters

Action Response

data
arrayRequired
error
string
successful
booleanRequired

SLUG: SERVICEM8_LIST_ALL_MATERIALS

Tool to list all materials. use when you need a full inventory dump after authenticating with read inventory scope.

Action Parameters

Action Response

data
arrayRequired
error
string
successful
booleanRequired

SLUG: SERVICEM8_LIST_ALL_TASKS

Tool to list all tasks in a servicem8 account. use when you need to fetch task records, optionally filtered. requires 'read tasks' oauth scope.

Action Parameters

filter
string
limit
integer
offset
integer

Action Response

data
arrayRequired
error
string
successful
booleanRequired

SLUG: SERVICEM8_RETRIEVE_CLIENT

Tool to retrieve details of a specific client by its uuid. use after confirming the client's uuid is valid.

Action Parameters

uuid
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SERVICEM8_RETRIEVE_FORM

Tool to retrieve details of a specific form by its uuid. use when you need up-to-date form metadata given a known form uuid.

Action Parameters

uuid
Required

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SERVICEM8_RETRIEVE_JOB

Tool to retrieve details of a specific job by its uuid. use when you have the job uuid and need its full record.

Action Parameters

uuid
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SERVICEM8_RETRIEVE_JOB_ACTIVITY

Tool to retrieve details of a specific job activity by its uuid. use when you have the job activity uuid and need its full details.

Action Parameters

uuid
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SERVICEM8_RETRIEVE_JOB_NOTE

Tool 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.

Action Parameters

uuid
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SERVICEM8_RETRIEVE_JOB_PAYMENT

Tool 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.

Action Parameters

uuid
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SERVICEM8_RETRIEVE_JOB_QUEUE

Tool to retrieve details of a specific job queue by its uuid. use when you need full queue metadata before dispatching work.

Action Parameters

uuid
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SERVICEM8_RETRIEVE_LOCATION

Tool to retrieve details of a specific location by its uuid. use when you already have the location's uuid and need full location details.

Action Parameters

uuid
Required

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SERVICEM8_RETRIEVE_MATERIAL

Tool to retrieve details of a specific material by its uuid. use when you have a material uuid and need current inventory or pricing details.

Action Parameters

uuid
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SERVICEM8_RETRIEVE_STAFF_MEMBER

Tool 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.

Action Parameters

uuid
Required

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SERVICEM8_SERVICE_M8_CREATE_JOB

Tool 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."

Action Parameters

active
integerDefaults to 1
badges
array
category_uuid
string
company_uuid
string
created_by_staff_uuid
string
date
string
job_address
stringRequired
job_description
string
purchase_order_number
string
queue_uuid
string
status
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SERVICEM8_UPDATE_JOB_NOTE

Tool to update details of an existing job note. use when modifying a note after its creation.

Action Parameters

active
integer
edit_date
string
note
string
uuid
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SERVICEM8_UPDATE_JOB_PAYMENT

Tool to update details of an existing job payment. use after confirming the payment uuid and desired changes.

Action Parameters

actioned_by_uuid
string
active
integer
amount
stringRequired
attachment_uuid
string
edit_date
string
is_deposit
integer
job_uuid
stringRequired
method
string
note
string
timestamp
string
uuid
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired