Zuper Properties API
Service property management and service task assignment
Zuper Properties API is one of 14 APIs that Zuper publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Properties. 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 5 operations across 2 paths, and defines 2 schemas. It is described by OpenAPI 3.0.3, at version 1.0.0.
Requests are made against 2 base URLs: https://{dc_region}.zuperpro.com/api, https://accounts.zuperpro.com/api.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Zuper Properties 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 5
Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
Service property management and service task assignment
Schemas 2
The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are AddressObject (6 properties), PaginatedResponse (4 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Zuper 12
Other APIs Zuper publishes across the network.