Bigtincan · OpenAPI Overlay 1.0.0

API Evangelist agent enhancements for Bigtincan Hub Public User API

9 actions 9 updates update extends openapi/bigtincan-user-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Bigtincan's API. It is a proposal applied on top of the contract, not a document Bigtincan publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-agent-consequencex-apievangelistx-mcp-candidate-tools

Targets 9

$.info
$.paths['/v1/user/{user_id}'].delete
$.paths['/v1/user/change-password'].patch
$.paths['/v1/user/forgot-password'].patch
$.paths['/v1/user/me'].get
$.paths['/v1/user/{user_id}/metadata'].get
$.paths['/v1/user/{user_id}/metadata'].patch
$.paths['/v1.1/user'].post
$.paths['/v1.1/user'].patch

OpenAPI Overlay

Raw ↑ 
overlay: 1.0.0
info:
  title: API Evangelist agent enhancements for Bigtincan Hub Public User API
  version: 1.0.0
extends: openapi/bigtincan-user-api-openapi.yml
x-provenance:
  generated: '2026-10-21'
  method: generated
  source: openapi/bigtincan-user-api-openapi.yml
  description: 'Adds agent-facing hints only: an x-agent-consequence per operation (read/write/destructive/external-effect,
    derived from HTTP method and path) and the candidate MCP tool names from mcp/bigtincan-mcp.yml. Bigtincan
    ships no MCP server; the tool names are candidates. The OpenAPI file is not mutated.'
actions:
- target: $.info
  description: Record API Evangelist provenance; the source contract is the Swagger 2.0 document Bigtincan
    serves at https://pubapi.bigtincan.com/api/sandbox/swagger/public-api.
  update:
    x-apievangelist:
      provider: bigtincan
      upstream: https://pubapi.bigtincan.com/api/sandbox/swagger/public-api
      docs: https://pubapi.bigtincan.com/doc/interactive/
      mcp_manifest: mcp/bigtincan-mcp.yml
- target: $.paths['/v1/user/{user_id}'].delete
  description: Agent hints for delete-v1-user-by-user-id (consequence derived from HTTP method/path).
  update:
    x-agent-consequence: destructive
- target: $.paths['/v1/user/change-password'].patch
  description: Agent hints for patch-v1-user-change-password (consequence derived from HTTP method/path).
  update:
    x-agent-consequence: write
- target: $.paths['/v1/user/forgot-password'].patch
  description: Agent hints for patch-v1-user-forgot-password (consequence derived from HTTP method/path).
  update:
    x-agent-consequence: write
- target: $.paths['/v1/user/me'].get
  description: Agent hints for get-v1-user-me (consequence derived from HTTP method/path).
  update:
    x-agent-consequence: read
    x-mcp-candidate-tools:
    - get_current_user
- target: $.paths['/v1/user/{user_id}/metadata'].get
  description: Agent hints for get-v1-user-by-user-id-metadata (consequence derived from HTTP method/path).
  update:
    x-agent-consequence: read
- target: $.paths['/v1/user/{user_id}/metadata'].patch
  description: Agent hints for patch-v1-user-by-user-id-metadata (consequence derived from HTTP method/path).
  update:
    x-agent-consequence: write
- target: $.paths['/v1.1/user'].post
  description: Agent hints for post-v1-1-user (consequence derived from HTTP method/path).
  update:
    x-agent-consequence: write
- target: $.paths['/v1.1/user'].patch
  description: Agent hints for patch-v1-1-user (consequence derived from HTTP method/path).
  update:
    x-agent-consequence: write

Work with this as data

Every overlay 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 openapi overlays

4 MCP tools reach this
  • find_overlaysBrowse and filter every overlay in the catalog.
  • 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 overlay 
curl "https://apis.io/api/v1/overlays/bigtincan-user-api-overlay"
All openapi overlays 
curl "https://apis.io/api/v1/overlays?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

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