For AI agents: visit https://developers.zuper.co/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

Home Guides API Reference Changelog Discussions

v1.0

API Reference

v1.0Home Guides API Reference Changelog Discussions

Zuper Pro API

Getting Started with Zuper API
Generating API Key

WORK ORDER MANAGEMENT

Jobs
Tasks
Projects
Measurements
Customers
Organizations
Properties
- Property CRUD
- /property/{property_uid}/summaryget
Assets
Documents
Service Contracts
Requests
🗨️Messaging & Chats
- Send Message To Stream Channelpost
- Add Users To Stream Channelpost
Workflow
Service Territory
Commissions
Request Status
- Get Request Statusesget

Inventory

Parts & Services
Stock Transactions
Pricelist
Vendor Management
- Vendor Catalogs
- Vendor CRUD
Subcontractor Management
Purchase Orders / Material Orders
Work Orders / Service Orders

Accounting

Quotes
Proposal
Invoices
Payments
Credit Notes

Zuper Connect

Calls
Conversations

User Management

Users
Teams
Timesheets
Trade Types

OTHERS

Update Custom Fieldspatch
Notes
- /notesget

Developer Features

Webhooks

FORM BUILDER

Checklists
Asset Inspection forms

zuper-pro-api

/purchase_orders/summary
- Get Purchase Order Summarypost
/service_orders/bulk_action
- Work Order Bulk Actionpost
/service_orders/bulk
- Bulk Create Work Orderpost
/purchase_orders/meta
- Get Purchase Orders Metaget
/service_orders/filter
- Get Work Orders By Filterpost
/service_orders/meta/filter
- Get Work Orders Meta Filterget
/service_orders/recover
- Recover Work Orderpost
/subcontractors/bulk_action
- Subcontractor Bulk Actionpost
/subcontractors/meta
- Get Subcontractors Metaget
/subcontractors/meta/filter
- Get Subcontractors Meta Filterget
/vendors/bulk_action
- Vendor Bulk Actionpost
/vendors/meta/filter
- Get Vendors Meta Filterget
/vendors/{vendor_uid}/activate
- Activate/Deactivate Vendorput
/request/status
- Create Request Statuspost
/request/status/{request_status_uid}
- Update Request Statusput
- Delete Request Statusdel
/estimate/filter
- Get Estimates By Filterpost
/invoice/meta
- Get Invoice Metaget
/invoice/meta/filter
- Get Invoice Meta Filterget
/jobs/meta
- Get Job Metaget
/jobs/meta/filter
- Get Job Meta Filterget
/product/filter
- Get Products By Filterpost
/product/meta
- Get Product Metaget
/request/status/reorder
- Reorder Request Statusesput
/subcontractors/filter
- Get Subcontractors By Filterpost
/subcontractors/{vendor_uid}/activate
- Activate/Deactivate Subcontractorput
/vendors/filter
- Get Vendors By Filterpost
/vendors/meta
- Get Vendors Metaget
/vendors/{vendor_uid}/catalog/delete
- Delete Multiple Vendor Catalogspost
/commissions/filter
/commissions/meta
/commissions/meta/filter
/payments/transactions/filter
/payments/transactions/meta/filter
/projects/filter
/projects/meta
/projects/meta/filter
/request/filter
/request/meta
/request/meta/filter
/routes/filter
/routes/meta/filter
/service_contract/filter
/service_contract/meta
/service_contract/meta/filter
/users/meta/filter
- Get User Meta Filterget
/customers/filter
/customers/meta
/customers/meta/filter
/organization/filter
/organization/meta
/organization/meta/filter
/property/filter
/property/meta
/property/meta/filter

Powered by

/customers/filter

Updated 23 minutes ago

Get User Meta Filter

/customers/meta

Did this page help you?

Updated 23 minutes ago

Get User Meta Filter

/customers/meta

Did this page help you?