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

WorkMotion Documents API

Employment documents attached to a talent.

WorkMotion Documents API is one of 7 APIs that WorkMotion 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 and API documentation.

This API exposes 3 operations across 2 paths, and defines 3 schemas. It is described by OpenAPI 3.0.3, at version 1.0.

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

3 operations 2 paths 3 schemas 2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0
Base URL
https://api.workmotion.com/v1
Authentication
HTTP Bearer
Contact
Terms of Service
Resource Areas
1

Authentication & Security 1

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

  • bearerAuth — OAuth 2.0 access token supplied as a Bearer token in the Authorization header. Partner credentials are issued by WorkMotion.

Paths & Operations 3

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

Documents 3

Employment documents attached to a talent.

GET
/employees/{employeeId}/documents
List documents for an employee
listDocuments 1 param → 200
POST
/employees/{employeeId}/documents
Upload a document for an employee
uploadDocument 1 param body → 201
GET
/documents/{documentId}
Download a document
downloadDocument 1 param → 200404

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are Document (6 properties), Error (2 properties), DocumentList (1 property). Each schema is shown below with its type and property counts.

DocumentList
object
1 property
Document
object
6 properties
Error
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

workmotion-documents-api-openapi.yml Raw ↑

Other APIs WorkMotion publishes across the network.

WorkMotion Absences API
WorkMotion Contracts API
WorkMotion Cost Calculator API
WorkMotion Employees API
WorkMotion Onboarding API
WorkMotion Webhooks API