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 Contracts API

Employment contracts and contract changes.

WorkMotion Contracts API is one of 7 APIs that WorkMotion publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Contracts. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 4 operations across 2 paths, and defines 6 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.

4 operations 2 paths 6 schemas 2 GET1 PATCH1 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 Contracts 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 4

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

Contracts 4

Employment contracts and contract changes.

GET
/employees/{employeeId}/contracts
List contracts for an employee
listEmployeeContracts 1 param → 200
POST
/employees/{employeeId}/contracts
Generate a contract for an employee
createContract 1 param body → 201
GET
/contracts/{contractId}
Retrieve a contract
getContract 1 param → 200404
PATCH
/contracts/{contractId}
Amend a contract
updateContract 1 param body → 200

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are Contract (9 properties), ContractChange (4 properties), ContractCreate (4 properties), Pagination (3 properties). Each schema is shown below with its type and property counts.

ContractList
object
2 properties
Contract
object
9 properties
ContractCreate
object
4 properties 2 required
Pagination
object
3 properties
ContractChange
object
A change applied to an existing contract.
4 properties
Error
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

workmotion-contracts-api-openapi.yml Raw ↑

Other APIs WorkMotion publishes across the network.

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