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

WorkSpan Users API

The Users API from WorkSpan — 2 operation(s) for users.

WorkSpan Users API is one of 26 APIs that WorkSpan 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.

This API exposes 4 operations across 2 paths. It is described by OpenAPI 3.0.1, at version 1.0.

Requests are made against a single base URL, https://api-sandbox.workspan.com/oauth.

4 operations 2 paths 0 schemas 2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0
Base URL
https://api-sandbox.workspan.com/oauth
Authentication
API Key, API Key
Resource Areas
1

Authentication & Security 2

WorkSpan Users API declares 2 security schemes for authenticating requests. An API key is passed in the header as Ocp-Apim-Subscription-Key (apiKeyHeader). An API key is passed in the query as subscription-key (apiKeyQuery). By default, every request must be authenticated, though some operations may also be called without credentials.

Paths & Operations 4

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

Users 4
POST
/Users
Create the user if user doesnt exist with the same email
createUser 1 param body → 201400401403404500
GET
/Users
search or list users
searchViaGet 4 params → 200400401403404500
GET
/Users/{user_id}
Get the user based on the id
getUser 2 params → 200400401403404500
PUT
/Users/{user_id}
Update/Suspend User if user with same id exist
updateUser 2 params body → 200400401403404500

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

workspan-users-api-openapi.yml Raw ↑

Other APIs WorkSpan publishes across the network.

WorkSpan Actions API
WorkSpan Audit API
WorkSpan Authorize API
WorkSpan Bulkload API
WorkSpan Bulkload Opportunity API
WorkSpan Chart Data API
WorkSpan Chart Metadata API
WorkSpan Check Attribute API
WorkSpan Cosell API
WorkSpan Crm Inbound API
WorkSpan Crm Inbound V2 API
WorkSpan Data API