Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Zuper Users API

Platform user management and skills tracking

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

Tagged areas include Users. 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 1 schema. 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.

5 operations 2 paths 1 schemas 1 DELETE2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 1

Zuper Users 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.

Users 5

Platform user management and skills tracking

GET
/users
Get All Users
getAllUsers 2 params → 200
POST
/users
Create User
createUser body → 200
GET
/users/{user_uid}
Get User Details
getUserDetails 1 param → 200404
PUT
/users/{user_uid}
Update User Details
updateUserDetails 1 param body → 200
DELETE
/users/{user_uid}
Delete User
deleteUser 1 param → 200

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is PaginatedResponse (4 properties). Each schema is shown below with its type and property counts.

PaginatedResponse
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zuper-users-api-openapi.yml Raw ↑

Other APIs Zuper publishes across the network.

Zuper Assets API
Zuper Authentication API
Zuper Customers 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 Vendors API