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

Whiplash Documents API

Document handling — list, create, retrieve, destroy, and actions

Whiplash Documents API is one of 10 APIs that Whiplash publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Documents. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, and rate-limit docs.

This API exposes 6 operations across 4 paths. It is described by OpenAPI 3.0.3, at version 2.0.

Requests are made against a single base URL, https://api.getwhiplash.com.

6 operations 4 paths 0 schemas 1 DELETE4 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
2.0
Base URL
https://api.getwhiplash.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Whiplash Documents API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (OAuth2) (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — OAuth 2.0 Bearer token. Obtain via authorization code or client credentials flow. See https://help.whiplash.com/hc/en-us/articles/360050870691-Authentication-f…

Paths & Operations 6

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

Documents 6

Document handling — list, create, retrieve, destroy, and actions

GET
/v2/documents
List documents
listDocuments 2 params → 200401
POST
/v2/documents
Create a document
createDocument body → 201401
GET
/v2/documents/actions
List available document actions
listDocumentActions → 200401
GET
/v2/documents/{id}
Retrieve a document
getDocument 1 param → 200401404
DELETE
/v2/documents/{id}
Delete a document
deleteDocument 1 param → 204401404
GET
/v2/templates/{id}
Retrieve a template
getTemplate 1 param → 200401404

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

whiplash-documents-api-openapi.yml Raw ↑

Other APIs Whiplash publishes across the network.

Whiplash Bundle Items API
Whiplash Consumer Returns API
Whiplash Customers API
Whiplash Items API
Whiplash Notification Events API
Whiplash Notification Subscriptions API
Whiplash Orders API
Whiplash Shipnotices API
Whiplash Simulate API