Jump to Content
Home
Guides
API Reference
Changelog
Discussions
v1.0
Log In
API Reference
Search
Log In
v1.0
Home
Guides
API Reference
Changelog
Discussions
Getting Started with Zuper API
All
Pages
Start typing to search…
JUMP TO
Zuper Pro API
Getting Started with Zuper API
Generating API Key
WORK ORDER MANAGEMENT
Jobs
Job CRUD
Create a Job
post
Get Jobs
get
Get Job Details
get
Update Job Assignment
post
Accept / Decline Job
post
Update a Job
put
Generate / Share Job Card PDF
post
Delete a Job
del
Restore Job
post
Job Status
Update Status & Checklist
put
Update Job Checklist
put
Rollback / Delete a Job Status
put
Job Schedule
Reschedule Job
put
Get Unscheduled Jobs
get
Assisted Scheduling
get
Conflicting Jobs & Time off
put
Job Timelog
Create a Job Timelog
post
Update a Job Timelog
put
Get Job Timelog
get
Get Job Timelog Summary
get
Get Job Timelog Summary Details
get
Delete Job Timelog
del
Job Note
Create Job Note
post
Get Job Notes
get
Update Job Note
put
Change Note Privacy
put
Delete Job Note
del
Job Routes
Create Route
post
Get Routes
get
Get Route Details
get
Get Routes Count
get
Update Route Details
put
Add Job To Route
put
Assign User Team To Route
post
Unassign User Team To Route
post
Reassign Job From Route
post
Reorder Jobs In Route
put
Clone Job Route
post
Optimize Job Route
post
Lock Job Route
put
Delete Job Route
del
Delete Job From Route
del
Recurring Jobs
Get Recurring Jobs
get
Update Recurring Job Schedule
put
Delete Reccurring Job
del
Job Attachments
Add Job Attachment
post
Update Job Attachment
put
Delete Job Attachment
del
Recurring Job Route
Create Recurring Route
post
Lock Recurring Route
put
Get Recurring Routes
get
Get Recurring Route Details
get
Associate Recurring Job To Recurring Route
post
Update Recurring Route Details
put
Assign/Unassign Users From Recurring Route
post
Move And Reorder Jobs In Recurring Route
put
Route Conflict Check With Jobs
post
Delete Recurring Route
del
Disassociate Recurring Job From Recurring Route
del
📁
Albums
Create Album
post
Get Albums
get
Update Album
put
Delete Album
del
Add Files to Album
post
Remove Files From Album
del
Share Album
post
Get Album Shares
get
Update Album Share
put
Delete Album Share
del
📁
Company Default Albums
Create Default Album
post
Get Default Albums
get
Update Default Album
put
Delete Default Album
del
Service Task
Create Service Tasks
post
Get Service Tasks
get
Get Service Task Details
get
Update Service Task Status
put
Update Service Task
put
Assign Service Task
put
Reorder Service Tasks
post
Bulk Action Service Task
post
Delete Service Task
del
Service Task
Projects
Project CRUD
Create Project
post
Get All Projects
get
Get Project Details
get
Update a project
put
Update Project Status
put
Update Assignment
post
Delete Project
del
Project Jobs
Link Job to Project
post
Reorder Jobs in Project
put
Remove Job from Project
del
Milestone
Create Milestone
post
Update Milestone
put
Update Milestone Status
put
Delete Milestone
del
Phases
Create Phase
post
Update Phase
put
Update Phase Items
post
Get All Phases
get
Reorder Phase
put
Reorder Phase Items
put
Delete Phase
del
Delete Phase Items
put
Dependencies
Create Dependency
post
Update Dependency
put
Check Dependency
post
Delete Dependency
del
Financials
Get Project Finance Stats
get
Measurements
Create Measurement
post
Get Measurements
get
Get Measurement Details
get
Update Measurement
put
Delete Measurement
del
Create Custom Measurement Token
post
Update Custom Measurement Token
put
Delete Custom Measurement Token
del
Customers
Customer CRUD
Create a Customer
post
Get all Customers
get
Get Customer Details
get
Update Customer
put
Merge Customers
get
Activate / Deactivate Customer
post
Delete Customer
del
Restore Customer
post
Attachments
Add Attachments
post
Update Attachment
put
Delete Attachment
del
Customer Notes
Create Customer Notes
post
Get Customer Note
get
Change Note Privacy
put
Update Customer Notes
put
Delete Customer Notes
del
Organizations
Organization CRUD
Create Organization
post
Get Organizations
get
Get Organization Details
get
Update Organization Details
put
Activate / Deactivate Organization
put
Delete Organization
del
Restore Organization
post
Attachments
Add Organization Attachments
post
Update Organization Attachment
put
Delete Organization Attachment
del
Properties
Property CRUD
Create Property
post
Get All Properties
get
Get Property Details
get
Update Property Details
put
Activate / Deactivate Property
put
Delete Property
del
Recover Property
post
Assets
Get All Assets
get
Get Asset Details
get
Create Asset
post
Delete Asset
del
Update Asset
put
Update Asset Status
put
Activate Asset
put
Asset Bulk Action
post
Recover Asset
post
Create Asset Card
post
Get Asset History
get
Create Asset Action
post
Get Asset Import Template
get
Get Sample Import Data
get
Import Asset Data
post
Service Contracts
Create service contract
post
Get Service Contracts
get
Get Service Contract Details
get
Update service contract
put
Delete Service Contract
del
Recover Contract
post
Activate/Deactivate Service Contract
put
Update Approval Status
put
Renew Service Contract
put
Send To Customer
post
Requests
Create Request
post
Get Requests
get
Get Request Details
get
Update Request
put
Update Request status
put
Delete Request
del
Inventory
Parts & Services
Product Master
Create a Product
post
Get all Products
get
Get a Product Details
get
Update a Product
put
Delete a Product
del
Product Groups
Create Products Group
post
Get All Products Group
get
Get Products Group Details
get
Update Products Group
put
Delete Products Group
del
Add Products to Products Group
post
Remove Products from Group
post
Activate Products Group
put
Stock Transactions
Create Inward Transcation
post
Create Outward Transaction
post
Create Transfer
post
Get all Products Transaction
get
Get Product transaction details
get
Update Overall Stock
Transfer Order
Create Transfer Order
post
Get all Transfer Orders
get
Get a Transfer Order
get
Update Transfer Order
put
Update Status of Transfer Order
put
Delete Transfer Order
del
Transfer Order Card
post
Create Transfer Order Attachment
post
Update Transfer Order Attachment
put
Delete Transfer Order Attachment
del
Pricelist
Create Pricelist
post
Get all Pricelist
get
Get a Pricelist Details
get
Update a Pricelist
put
Activate / Deactivate
put
Delete Pricelist
del
Vendor Management
Create Vendor
post
Update Vendor
put
Delete Vendor
del
Get All Vendors
get
Get Vendor Details
get
Vendor Catalogs
Create Vendor Catalogs
post
Update Vendor Catalog
put
Get Vendor Catalogs
get
Delete Vendor Catalog
del
Purchase Orders
Create Purchase Order
post
Update Purchase Order
put
Delete Purchase Order
del
Get Purchase Orders
get
Get Purchase Order Details
get
Update Purchase Order Status
put
Send Purchase Order
post
Accounting
Quotes
Create a Quote
post
Get all Quote
get
Get a Quote
get
Update a Quote
put
Update Quote Status
put
Send a Quote
post
Bulk Action Quote
post
Delete a Quote
del
Recover a Quote
post
Unarchive a Quote
put
Invoices
Create a Invoice
post
Get all Invoice
get
Get Invoice Details
get
Update a Invoice
put
Update Invoice Status
put
Send a Invoice
post
Delete a Invoice
del
Restore a Invoice
post
Unarchive a Invoice
put
Payments
Get payments
get
Get payment details
get
Void a payment
put
Proposal
Create a Proposal
post
Get all Proposal
get
Get a Proposal
get
Update a Proposal
put
Update Proposal Status
put
Delete a Proposal
del
Update Proposal Options
patch
Packages
Create a Package
post
Get all Packages
get
Get a Package
get
Update a Package
put
Activate/Deactivate a Package
put
Reorder Packages
post
Delete a Package
del
Templates
Create a Template
post
Get all Templates
get
Get a Template
get
Update a Template
put
Activate/Deactivate a Template
put
Delete a Template
del
Quote/Invoice/Contract Attachments
Create attachment
post
Delete Attachment
del
Credit Notes
Create Credit Note
post
Get All Credit Notes
get
Get Credit Note Details
get
Delete Credit Note
del
Credit Note History
Get Customer Credit Note Histories
get
User Management
Users
Create User
post
Get All Users
get
Get User Details
get
Update User Details
put
Delete User
del
Activate / Deactivate User
get
User Skills
Create User Skills
post
Get User Skills
get
Update User Skills
put
Delete User Skills
del
User Timelogs
Get Users Timelog
get
Get User Timelog Details
get
Teams
Create Team
post
Get All Teams
get
Get Team Details
get
Update Team Details
put
Delete Team
del
Restore Team
get
Assign/Unassign User
Assign User To Team
post
Unassign User From Team
post
Timesheets
Timesheets CRUD
Get Timesheets
get
Get Timesheet Summary
get
Create Timesheet
post
Update Timesheet
put
Delete Timesheet
del
Timeoff
Create Timeoff Request
post
Get Timeoff Requests
get
Get Timeoff Request Details
get
Edit Timeoff Request
put
Update Approval Status
put
Delete Timeoff Request
del
Timesheet Location
Create Timesheet Location
post
Get Timesheet Location
get
Get Location Details
get
Update Timesheet Location
put
Delete Timesheet Location
del
Timeoff Request Type
Create Timeoff Request Type
post
Get Timeoff Request Type
get
Update Timeoff Request Type
put
Delete Timeoff Request Type
del
Reorder Timeoff Request Type
post
Timeoff Availability
Create Timeoff Availability
post
Get Timeoff Availability
get
Update Timeoff Availability
put
Delete Timeoff Availability
del
OTHERS
Update Custom Fields
patch
Developer Features
Webhooks
Create a Webhook
post
Get Webhooks
get
Get Webhook Details
get
Update Webhook
post
Activate/Deactivate Webhook
post
Delete Webhook
del
Powered by
Getting Started with Zuper API
Ask AI
This page will help you get started with Zuper Pro API.
