# zuper-sdk

> Zuper SDK

Latest version **1.0.56** (published 2025-05-06) · ISC license · 0 weekly downloads

## Install

```sh
npm install zuper-sdk
pnpm add zuper-sdk
yarn add zuper-sdk
bun add zuper-sdk
```

## Health

**Score 25/100 (F)** — status: maintenance-mode.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: stale; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.56 |
| Published | 2025-05-06 |
| First published | 2023-03-24 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Node | 14.15.5 |
| Dependencies | 1 |
| Unpacked size | 80.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | zuper |
| Maintainers | zuperengineer |
| Keywords | Zuper |

## Links

- npm: https://www.npmjs.com/package/zuper-sdk
- npm.io page: https://npm.io/package/zuper-sdk

## Dependencies (1)

- [axios](https://npm.io/package/axios.md) ^1.9.0

## Recent versions

- 1.0.56 (latest) — 2025-05-06
- 1.0.55 — 2024-12-12
- 1.0.54 — 2024-12-12
- 1.0.53 — 2024-05-30
- 1.0.52 — 2023-12-26
- 1.0.51 — 2023-12-22
- 1.0.5 — 2023-12-22
- 1.0.41 — 2023-11-02
- 1.0.4 — 2023-10-20
- 1.0.31 — 2023-07-26
- 1.0.3 — 2023-04-27
- 1.0.21 — 2023-03-29
- 1.0.1 — 2023-03-24
- 1.0.0 — 2023-03-24

## README

**Zuper-SDK**

Zuper Field Service Management platform lets you reimagine field service delivery and delight your customers. Collaborate Seamlessly with your field teams anytime, anywhere.

**Download & Installation:**

```
npm i -s zuper-sdk
```

**To generate API Key:**

1. On Zuper [Webapp](https://app.zuperpro.com/), Click on Settings from the left menu.
2. Under 'General setting' click on "Account".
3. In the "Account Settings" click on "API Keys".
4. Under the "Your API Key" section, click on "New API Key", in the pop-up enter the "API Key Name" and click on create.
5. Your API key will be generated and displayed.

**Modules:**

| *Module*       | *Permitted Operations*                                                                |
| ---------------- | ----------------------------------------------------------------------------------- |
| Jobs             | get, getAll, create, update, updateStatus, delete, updateSchedule, updateAssignment, getJobTimelogs, rollbackStatus, getAllRecurringJobs, getAssistedScheduling          |
| Property         | get, getAll, create, update, updateStatus, delete                                   |
| Customers        | get, getAll, create, update, sendEmail, delete                                      |
| Organizations    | get, getAll, create, update, delete                                                 |
| Users            | get, getAll, create, update, delete, getWorkHours, getUserTeams                     |
| Assets           | get, getAll, create, update, getHistory, getInspectionForm, updateStatus, getPPM, delete    |
| Quotes           | get, getAll, create, update, delete, updateStatus                                   |
| Invoices         | get, getAll, create, update, delete, updateStatus                                   |
| Parts & Services | get, getAll, create, update, createTranscation, getTranscations, delete             |
| Activity         | get, create                                                                         |
| Misc             | notify ( Send Email / SMS )                                                         |
| Service Taks     | get, getAll, create, update, delete, bulkAction, updateStatus, assignUsers, reorder |
| Proposal         | get, getAll, create, update, delete, updateStatus                                   |
| Requests         | get, getAll, create, update, updateStatus, delete, rollbackStatus, createAssignment, createAttachment, updateAttachment, deleteAttachment           |
| Projects         | get, getAll, create, update, updateStatus, delete, recover, assign, updateAssignment, linkJob, removeJob, createMilestone, updateMilestone, updateMilestoneStatus, deleteMilestone, createPhase, updatePhase, updatePhaseItems, getAllPhases, deletePhase, deletePhaseItems, createDependency, updateDependency, deleteDependency |
| Transfer Orders  | get, getAll, create, update,updateStatus, createAttachment, deleteAttachment |

**Example:**

```
const Zuper = require("zuper-sdk");
const zuper = Zuper.init("<origin>", "<Zuper API key>");

const jobs = async () => {
  try {
    let jobs = await zuper.jobs.get("<job_uid>");
    console.log("Get Job details", jobs);
  } catch (e) {
    console.log("Error:", e);
  }
};

let jobsList = async () => {
  try {
    let options = {
      page: 1,
      count: 2,
      filter: {
        priority: "LOW",
      },
    };
    let jobs = await zuper.jobs.getAll(options);
    console.log("Get Job details", jobs);
  } catch (e) {
    console.log("Error:", e);
  }
};

```

**More:**

<p>
  
  <pre><b>Jobs</b></pre>
  
  - get(job_uid) 
  - getAll(options)
  - create(payload)
  - update(payload)
  - updateStatus(job_uid, payload)
  - delete(job_uid)
  - updateSchedule(payload)
  - updateAssignment(payload)
  - getJobTimelogs(job_uid)
  - rollbackStatus(job_uid, payload)
  - getAllRecurringJobs(options)
  - getAssistedScheduling(options)

  <pre><b>Property</b></pre>
  
  - get(property_uid) 
  - getAll(options)
  - create(payload)
  - update(property_uid, payload)
  - updateStatus(property_uid, payload)
  - delete(property_uid)
  
  <pre><b>Customers</b> </pre>
  
  - get(customer_uid) 
  - getAll(options)
  - create(payload)
  - update(customer_uid, payload)
  - sendEmail(customer_uid, payload)
  - delete(customer_uid)
  
  <pre><b>Organizations</b> </pre>
  
  - get(organization_uid) 
  - getAll(options)
  - create(payload)
  - update(organization_uid, payload)
  - delete(organization_uid)
  
  <pre><b>Users</b> </pre>
  
  - get(user_uid) 
  - getAll(options)
  - create(payload)
  - update(user_uid, payload)
  - delete(user_uid)
  - getWorkHours(user_uid)
  - getUserTeams(user_uid)
  
  <pre><b>Assets</b> </pre>
  
  - get(asset_uid) 
  - getAll(options)
  - create(payload)
  - update(asset_uid, payload)
  - getHistory(asset_uid, options)
  - getInspectionForm(asset_uid, options)
  - updateStatus(asset_uid, params)
  - getPPM(options)
  - delete(asset_uid)
  
  <pre><b>Quotes</b> </pre>
  
  - get(estimate_uid) 
  - getAll(options)
  - create(payload)
  - updateStatus(estimate_uid, payload)
  - update(estimate_uid, payload)
  - delete(estimate_uid)
  
  <pre><b>Invoices</b> </pre>
  
  - get(invoice_uid) 
  - getAll(options)
  - create(payload)
  - updateStatus(invoice_uid, payload)
  - update(invoice_uid, payload)
  - delete(invoice_uid)
  
  <pre><b>Parts & Services</b> </pre>
  
  - get(product_uid) 
  - getAll(options)
  - create(payload)
  - update(product_uid, payload)
  - createTranscation(product_uid, type, payload)
  - getTranscations(params)
  - delete(product_uid)

  <pre><b>Activity</b> </pre>
  
  - get(payload) 
  - create(payload)
  
  <pre><b>Misc</b> </pre>
  
  - notify(module, entity_uid, payload) 

  <pre><b>Service Tasks</b> </pre>
  
  - getAll(options)
  - get(service_task_uid)
  - create(payload)
  - update(service_task_uid, payload)
  - delete(service_task_uid)
  - bulkAction(payload)
  - updateStatus(service_task_uid, payload)
  - assignUsers(service_task_uid, payload)
  - reorder(payload)

  <pre><b>Proposal</b> </pre>
  - get(proposal_uid) 
  - getAll(options)
  - create(payload)
  - updateStatus(proposal_uid, payload)
  - update(proposal_uid, payload)
  - delete(proposal_uid)

  <pre><b>Requests</b> </pre>
  - get(request_uid) 
  - getAll(options)
  - create(payload)
  - update(request_uid, payload)
  - updateStatus(request_uid, payload)
  - delete(request_uid)
  - rollbackStatus(request_uid, payload)
  - createAssignment(payload)
  - createAttachment(request_uid,payload)
  - updateAttachment(request_uid,attachment_uid,payload)
  - deleteAttachment(request_uid,attachment_uid)
  <pre><b>Projects</b> </pre>
  - get(project_ui) 
  - getAll(options)
  - create(payload)
  - update(payload)
  - updateStatus(project_uid, payload)
  - delete(project_uid)
  - recover(payload)
  - assign(payload)
  - updateAssignment(payload)
  - linkJob(project_uid, job_uid, payload)
  - removeJob(project_uid, job_uid, delete_job)
  - createMilestone(project_uid, payload)
  - updateMilestone(project_uid, milestone_uid, payload)
  - updateMilestoneStatus(project_uid, milestone_uid, payload)
  - deleteMilestone(project_uid, milestone_uid)
  - createPhase(project_uid, payload)
  - updatePhase(project_uid, phase_uid, payload)
  - updatePhaseItems(project_uid, phase_uid, payload)
  - getAllPhases(project_uid)
  - deletePhase(project_uid, phase_uid, detach)
  - deletePhaseItems(project_uid, phase_uid, payload)
  - createDependency(project_uid, payload)
  - updateDependency(project_uid, dependency_uid, payload)
  - deleteDependency(project_uid, dependency_uid)
  <pre><b>Transfer Orders</b> </pre>
  - get(transfer_order_uid) 
  - getAll(options)
  - create(payload)
  - update(transfer_order_uid, payload)
  - updateStatus(transfer_order_uid, payload)
  - createAttachment(transfer_order_uid,payload)
  - deleteAttachment(transfer_order_uid,attachment_uid)
</p>
&nbsp;

[Click here for the full Documentation](https://developers.zuper.co/api-docs/#introduction)

---
_Source: https://npm.io/package/zuper-sdk · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._