How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Zuper Customers API

Customer relationship management — create, update, search, and manage customer records

Zuper Customers API is one of 14 APIs that Zuper publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Customers. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, an API reference, a changelog, and authentication docs.

This API exposes 6 operations across 3 paths, and defines 6 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against 2 base URLs: https://{dc_region}.zuperpro.com/api, https://accounts.zuperpro.com/api.

6 operations 3 paths 6 schemas 1 DELETE3 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://accounts.zuperpro.com/api
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Zuper Customers API declares 1 security scheme for authenticating requests. An API key is passed in the header as x-api-key (ApiKeyAuth). By default, every request must be authenticated.

  • ApiKeyAuth — API key generated from Zuper Settings Developer Hub API Keys

Paths & Operations 6

Across 3 paths, the API surfaces 6 operations — 1 DELETE, 3 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Customers 6

Customer relationship management — create, update, search, and manage customer records

GET
/customers
Get All Customers
getAllCustomers 23 params → 200400500
POST
/customers
Create a Customer
createCustomer body → 200400
GET
/customers/{customer_uid}
Get Customer Details
getCustomerDetails 1 param → 200404
PUT
/customers/{customer_uid}
Update Customer
updateCustomer 1 param body → 200400
DELETE
/customers/{customer_uid}
Delete Customer
deleteCustomer 1 param → 200404
GET
/customers/{customer_uid}/summary
Get Customer Summary
getCustomerSummary 1 param → 200

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are Customer (17 properties), AddressObject (6 properties), PaginatedResponse (4 properties), CustomField (4 properties). Each schema is shown below with its type and property counts.

CustomField
object
4 properties
ContactNo
object
3 properties
PaginatedResponse
object
4 properties
AddressObject
object
6 properties
ErrorResponse
object
2 properties
Customer
object
17 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zuper-customers-api-openapi.yml Raw ↑

Other APIs Zuper publishes across the network.

Zuper Assets API
Zuper Authentication API
Zuper Invoices API
Zuper Jobs API
Zuper Organizations API
Zuper Projects API
Zuper Properties API
Zuper Purchase Orders API
Zuper Teams API
Zuper Timesheets API
Zuper Users API
Zuper Vendors API
Where this information came from

This is an independent, third-party profile of Zuper Customers API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.