WorkSpan

WorkSpan External Id API

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

Documentation GitHub OpenAPI

Operations 2

PATCH /{object_id}/external_id Connect an external ID to a WorkSpan ID #

GET /{object_id}/external_id Get external ID for WorkSpan ID #

Specifications

⚙

OpenAPI

https://raw.githubusercontent.com/api-evangelist/workspan/refs/heads/main/openapi/workspan-external-id-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/workspan-external-id-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Authentication Actions External Id API
  description: 'Implementation of [OAuth 2.0](https://tools.ietf.org/html/rfc6749  "Docs") with Client Credentials Grant type

    '
  version: '1.0'
servers:
- url: https://api-sandbox.workspan.com/oauth
security:
- {}
- apiKeyHeader: []
- apiKeyQuery: []
tags:
- name: External Id
paths:
  /{object_id}/external_id:
    patch:
      operationId: update_external_id
      summary: Connect an external ID to a WorkSpan ID
      description: Connect an external ID to a WorkSpan ID
      parameters:
      - name: object_id
        in: path
        required: true
        schema:
          type: string
        description: Object ID assigned by WorkSpan (long ID)
      requestBody:
        content:
          application/json:
            examples:
              default:
                value: "{\n  \"field_name\": \"sales_details.crm_opportunity_id\",\n  \"external_id\": \"000owa24575\"\n}"
      responses:
        '200':
          description: Connection of external object to WorkSpan object is successful
          content:
            application/json:
              examples:
                default:
                  value: "{\n  \"object_id\": \"WS-Project_agpzfndzLWF\",\n  \"external_id\": \"000owa24575\",\n  \"field_name\": \"sales_details.crm_opportunity_id\"\n}"
        '401':
          description: Authorization Error
        '404':
          description: WorkSpan object not found
      tags:
      - External Id
    get:
      operationId: get_external_id
      summary: Get external ID for WorkSpan ID
      description: Get external ID for WorkSpan ID
      parameters:
      - name: object_id
        in: path
        required: true
        schema:
          type: string
        description: Object ID assigned by WorkSpan (long ID)
      responses:
        '200':
          description: Retrieving external ID of a WorkSpan Object is successful
          content:
            application/json:
              examples:
                default:
                  value: "{\n  \"object_id\": \"WS-Project_agpzfndzLWF\",\n  \"external_ids\": [\n    {\n      \"external_id\": \"000owa24575\",\n      \"field_name\": \"sales_details.crm_opportunity_id\"\n    },\n    {\n      \"external_id\": \"pc-a1w09875\",\n      \"field_name\": \"partner_center.referral_id\"\n    }\n  ]\n}"
        '401':
          description: Authorization Error
        '404':
          description: WorkSpan object not found
      tags:
      - External Id
components:
  securitySchemes:
    apiKeyHeader:
      type: apiKey
      name: Ocp-Apim-Subscription-Key
      in: header
    apiKeyQuery:
      type: apiKey
      name: subscription-key
      in: query
x-harvest:
  source: https://developer.workspan.com/developer/apis/authentication-api?export=true&format=openapi+json&api-version=2022-04-01-preview
  operations_source: https://developer.workspan.com/developer/apis/authentication-api/operations?api-version=2022-04-01-preview
  harvested: '2026-07-21'
  note: Assembled from WorkSpan's Azure APIM developer portal data API (export skeleton + published operations/schemas).