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

Teambridge Mappings API

Endpoints for managing external system mappings. Mappings link Teambridge recordsto entities in external systems (like Bullhorn, ADP, etc.) by storing the externalprovider code, external ID, and object type.

Teambridge Mappings API is one of 4 APIs that Teambridge publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Mappings. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.

This API exposes 4 operations across 2 paths, and defines 5 schemas. It is described by OpenAPI 3.1.0, at version 0.1.0.

Requests are made against a single base URL, https://open-api.teambridge.com.

4 operations 2 paths 5 schemas 1 DELETE1 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
0.1.0
Base URL
https://open-api.teambridge.com
Authentication
OAuth 2.0, API Key
Resource Areas
1

Authentication & Security 2

Teambridge Mappings API declares 2 security schemes for authenticating requests. It supports OAuth 2.0 (OAuth2) using the clientCredentials flow, exposing 1 scope. An API key is passed in the header as X-Webhook-Signature (WebhookSignature). By default, every request must be authenticated.

  • WebhookSignature — HMAC-SHA256 signature for webhook authentication. The signature is computed from the concatenation of the timestamp and request body: {timestamp}.{body}. The s…

Paths & Operations 4

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

Mappings 4

Endpoints for managing external system mappings. Mappings link Teambridge records to entities in external systems (like Bullhorn, ADP, etc.) by storing the external provider code,…

GET
/v1/mappings
List all mappings for a record
listMappings 1 param → 200400401
POST
/v1/mappings
Create a new mapping
createMapping body → 200400401
PUT
/v1/mappings/{mappingId}
Update an existing mapping
updateMapping 1 param body → 200400401404
DELETE
/v1/mappings/{mappingId}
Delete a mapping
deleteMapping 1 param → 204401404

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are MappingDto (6 properties), CreateMappingRequest (4 properties), ErrorDetail (2 properties), StandardErrorResponse (2 properties). Each schema is shown below with its type and property counts.

StandardErrorResponse
object
2 properties 1 required
MappingDto
object
6 properties 5 required
UpdateMappingRequest
object
1 property 1 required
CreateMappingRequest
object
4 properties 4 required
ErrorDetail
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

teambridge-mappings-api-openapi.yml Raw ↑

Other APIs Teambridge publishes across the network.

Teambridge Collections (Unified API) API
Teambridge Documents API
Teambridge Utilities API