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 External Id API

The External Id API from WorkSpan — 1 operation(s) for external id.

WorkSpan External Id API is one of 26 APIs that WorkSpan publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include External Id. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 2 operations across 1 path. 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.

2 operations 1 paths 0 schemas 1 GET1 PATCH

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 External Id 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 2

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

External Id 2
PATCH
/{object_id}/external_id
Connect an external ID to a WorkSpan ID
update_external_id 1 param body → 200401404
GET
/{object_id}/external_id
Get external ID for WorkSpan ID
get_external_id 1 param → 200401404

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

workspan-external-id-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