For AI agents: visit https://developer.servicem8.com/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI. Append .md to any documentation page URL to get its markdown version.
Jump to Content
Guides
API Reference
Discussions
Home
Guides
API Reference
Guides
API Reference
Discussions
Log In
API Reference
Search
Log In
API Reference
My Requests
ServiceM8 API
Allocation Windows
List all Allocation Windows
get
Create a new Allocation Window
post
Retrieve an Allocation Window
get
Update an Allocation Window
post
Delete an Allocation Window
del
Asset Type Fields
List all Asset Type Fields
get
Create a new Asset Type Field
post
Retrieve an Asset Type Field
get
Update an Asset Type Field
post
Delete an Asset Type Field
del
Asset Types
List all Asset Types
get
Create a new Asset Type
post
Retrieve an Asset Type
get
Update an Asset Type
post
Delete an Asset Type
del
Assets
List all Assets
get
Retrieve an Asset
get
Update an Asset
post
Delete an Asset
del
Attachments
List all Attachments
get
Create a new Attachment
post
Retrieve an Attachment
get
Update an Attachment
post
Delete an Attachment
del
Download an Attachment file
get
Upload an Attachment file (legacy workflow)
post
Availabilities
List all Availabilities
get
Create a new Availability
post
Retrieve an Availability
get
Update an Availability
post
Delete an Availability
del
Badges
List all Badges
get
Create a new Badge
post
Retrieve a Badge
get
Update a Badge
post
Delete a Badge
del
Bundles
List all Bundles
get
Create a new Bundle
post
Retrieve a Bundle
get
Update a Bundle
post
Delete a Bundle
del
Categories
List all Categories
get
Create a new Category
post
Retrieve a Category
get
Update a Category
post
Delete a Category
del
Clients
List all Clients
get
Create a new Client
post
Retrieve a Client
get
Update a Client
post
Delete a Client
del
Company Contacts
List all Company Contacts
get
Create a new Company Contact
post
Retrieve a Company Contact
get
Update a Company Contact
post
Delete a Company Contact
del
Document Templates
List all Document Templates
get
Create a new Document Template
post
Retrieve a Document Template
get
Update a Document Template
post
Delete a Document Template
del
Email Templates
List all Email Templates
get
Create a new Email Template
post
Retrieve an Email Template
get
Update an Email Template
post
Delete an Email Template
del
Feedback
List all Feedback
get
Create a new Feedback
post
Retrieve a Feedback
get
Update a Feedback
post
Delete a Feedback
del
Form Fields
List all Form Fields
get
Create a new Form Field
post
Retrieve a Form Field
get
Update a Form Field
post
Delete a Form Field
del
Form Responses
List all Form Responses
get
Create a new Form Response
post
Retrieve a Form Response
get
Update a Form Response
post
Delete a Form Response
del
Forms
List all Forms
get
Create a new Form
post
Retrieve a Form
get
Update a Form
post
Delete a Form
del
Job Activities
List all Job Activities
get
Create a new Job Activity
post
Retrieve a Job Activity
get
Update a Job Activity
post
Delete a Job Activity
del
List all Job Activities
get
Retrieve a Job Activity
get
Job Allocations
List all Job Allocations
get
Create a new Job Allocation
post
Retrieve a Job Allocation
get
Update a Job Allocation
post
Delete a Job Allocation
del
Job Checklists
List all Job Checklists
get
Create a new Job Checklist
post
Retrieve a Job Checklist
get
Update a Job Checklist
post
Delete a Job Checklist
del
Job Contacts
List all Job Contacts
get
Create a new Job Contact
post
Retrieve a Job Contact
get
Update a Job Contact
post
Delete a Job Contact
del
Job Material Bundles
List all Job Material Bundles
get
Create a new Job Material Bundle
post
Retrieve a Job Material Bundle
get
Update a Job Material Bundle
post
Delete a Job Material Bundle
del
Job Materials
List all Job Materials
get
Create a new Job Material
post
Retrieve a Job Material
get
Update a Job Material
post
Delete a Job Material
del
Job Payments
List all Job Payments
get
Create a new Job Payment
post
Retrieve a Job Payment
get
Update a Job Payment
post
Delete a Job Payment
del
Job Queues
List all Job Queues
get
Create a new Job Queue
post
Retrieve a Job Queue
get
Update a Job Queue
post
Delete a Job Queue
del
Job Templates
Create a job from a template
post
List all Job Templates
get
Retrieve a Job Template
get
Jobs
List all Jobs
get
Create a new Job
post
Retrieve a Job
get
Update a Job
post
Delete a Job
del
Knowledge Articles
List all Knowledge Articles
get
Create a new Knowledge Article
post
Retrieve a Knowledge Article
get
Update a Knowledge Article
post
Delete a Knowledge Article
del
Locations
List all Locations
get
Create a new Location
post
Retrieve a Location
get
Update a Location
post
Delete a Location
del
Materials
List all Materials
get
Create a new Material
post
Retrieve a Material
get
Update a Material
post
Delete a Material
del
Notes
List all Notes
get
Create a new Note
post
Retrieve a Note
get
Update a Note
post
Delete a Note
del
SMS Templates
List all SMS Templates
get
Create a new SMS Template
post
Retrieve a SMS Template
get
Update a SMS Template
post
Delete a SMS Template
del
Security Roles
List all Security Roles
get
Retrieve a Security Role
get
Staff Members
List all Staff Members
get
Create a new Staff Member
post
Retrieve a Staff Member
get
Update a Staff Member
post
Delete a Staff Member
del
Staff Messages
List all Staff Messages
get
Create a new Staff Message
post
Retrieve a Staff Message
get
Update a Staff Message
post
Delete a Staff Message
del
Staff Time Events
List all Staff Time Events
get
Retrieve a Staff Time Event
get
Suppliers
List all Suppliers
get
Create a new Supplier
post
Retrieve a Supplier
get
Update a Supplier
post
Delete a Supplier
del
Tasks
List all Tasks
get
Create a new Task
post
Retrieve a Task
get
Update a Task
post
Delete a Task
del
Tax Rates
List all Tax Rates
get
Create a new Tax Rate
post
Retrieve a Tax Rate
get
Update a Tax Rate
post
Delete a Tax Rate
del
Vendors
List all Vendors
get
Retrieve a Vendor
get
ServiceTemplates
List ServiceTemplates
get
Get a ServiceTemplate
get
Create or update a ServiceTemplate
post
Soft-delete a ServiceTemplate
del
Diary
Create an Add-on Job Diary item
post
Email
List job email history
get
Get one job email record
get
Inbox
List inbox messages
get
Get inbox message details
get
Mark message as read
put
Archive or unarchive message
put
Snooze or unsnooze message
put
Convert message to job
post
Attach message to existing job
post
Add note to message
post
Create a new inbox message
post
Notifications
Create add-on notifications
post
Search
Search across multiple object types
get
Search within a specific object type
get
Semantic search for jobs
get
SMS
List job SMS history
get
Get one job SMS record
get
Messaging API
Email
Send an Email
post
SMS
Send an SMS Message
post
Document Templates API
Document Templates
Produce a Templated Document
post
Custom Fields API
Custom Fields
List Custom Fields
get
Create or Update a Custom Field.
post
Delete a Custom Field
del
Webhooks API
Webhook Subscription
List Webhook Subscriptions
get
Delete a Webhook Subscription
del
Create or Update an Object Webhook Subscription
post
Create or Update an Event Webhook Subscription
post
Provisioning API
Account Provisioning
Provision a new ServiceM8 account
post
Feed API
Feed
Post a message to the activity feed
post
Addon SDK API
Key Value Storage
List all keys for a job
get
Get one key for a job
get
Set one key for a job
put
Delete one key for a job
del
List all keys for an account
get
Get one key for an account
get
Set one key for an account
put
Delete one key for an account
del
Add-on Management
List the account's add-ons
get
Fetch one add-on by slug
get
Deploy an add-on (atomic manifest + function upsert)
put
Poll deployment status
get
List secret names for an add-on
get
Set a secret
put
Delete a secret
del
Identify the authenticated account
get
Stream live logs for one add-on over SSE
post
Manifest Schema
Get the add-on manifest v1 JSON Schema
get
Diary
Create an Add-on Job Diary item
post
Notifications
Create Add-on notifications
post
Powered by
