WorkMotion Employees API

openapi: 3.0.3
info:
  title: WorkMotion Partner Absences Employees API
  description: 'Partner / Open API for the WorkMotion global employment and Employer of Record (EOR) platform. It exposes employees (talents), employment contracts, onboarding workflows, absences and time-off, documents, employment cost calculations, and webhook subscriptions so that HRIS and payroll systems can integrate with WorkMotion''s managed employment infrastructure across 160+ countries.

    NOTE: WorkMotion''s partner API is access-gated and its reference documentation is not fully published to the open web. The paths and schemas below are a faithful, honest model of the documented product surfaces (employees, contracts, onboarding, absences, documents, cost calculator, webhooks) rather than a verbatim copy of an official OpenAPI file. Verify exact paths, fields, and semantics against the WorkMotion partner documentation during reconciliation.'
  termsOfService: https://workmotion.com/terms-and-conditions/
  contact:
    name: WorkMotion
    url: https://workmotion.com/integrations/
  version: '1.0'
servers:
- url: https://api.workmotion.com/v1
  description: Production (modeled base URL; confirm with partner documentation)
security:
- bearerAuth: []
tags:
- name: Employees
  description: Talents employed through WorkMotion.
paths:
  /employees:
    get:
      operationId: listEmployees
      tags:
      - Employees
      summary: List employees
      description: Returns a paginated list of talents employed through WorkMotion.
      parameters:
      - $ref: '#/components/parameters/PageParam'
      - $ref: '#/components/parameters/PageSizeParam'
      - name: status
        in: query
        required: false
        schema:
          type: string
          enum:
          - onboarding
          - active
          - offboarding
          - terminated
      - name: country
        in: query
        required: false
        description: ISO 3166-1 alpha-2 country of employment.
        schema:
          type: string
      responses:
        '200':
          description: A page of employees.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmployeeList'
        '401':
          $ref: '#/components/responses/Unauthorized'
    post:
      operationId: createEmployee
      tags:
      - Employees
      summary: Create an employee
      description: Creates a new talent record, typically the first step of onboarding.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EmployeeCreate'
      responses:
        '201':
          description: Employee created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Employee'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /employees/{employeeId}:
    parameters:
    - $ref: '#/components/parameters/EmployeeIdParam'
    get:
      operationId: getEmployee
      tags:
      - Employees
      summary: Retrieve an employee
      responses:
        '200':
          description: The requested employee.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Employee'
        '404':
          $ref: '#/components/responses/NotFound'
    patch:
      operationId: updateEmployee
      tags:
      - Employees
      summary: Update an employee
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EmployeeUpdate'
      responses:
        '200':
          description: The updated employee.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Employee'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  responses:
    NotFound:
      description: Resource not found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: Missing or invalid access token.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  parameters:
    PageParam:
      name: page
      in: query
      required: false
      schema:
        type: integer
        minimum: 0
        default: 0
    PageSizeParam:
      name: pageSize
      in: query
      required: false
      schema:
        type: integer
        minimum: 1
        maximum: 200
        default: 50
    EmployeeIdParam:
      name: employeeId
      in: path
      required: true
      schema:
        type: string
  schemas:
    EmployeeList:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Employee'
        pagination:
          $ref: '#/components/schemas/Pagination'
    Pagination:
      type: object
      properties:
        page:
          type: integer
        pageSize:
          type: integer
        total:
          type: integer
    Employee:
      type: object
      properties:
        id:
          type: string
        firstName:
          type: string
        lastName:
          type: string
        email:
          type: string
          format: email
        countryOfEmployment:
          type: string
          description: ISO 3166-1 alpha-2 country code.
        employmentType:
          type: string
          enum:
          - eor
          - direct
          - contractor
        status:
          type: string
          enum:
          - onboarding
          - active
          - offboarding
          - terminated
        startDate:
          type: string
          format: date
        createdAt:
          type: string
          format: date-time
    EmployeeUpdate:
      type: object
      properties:
        email:
          type: string
          format: email
        status:
          type: string
          enum:
          - onboarding
          - active
          - offboarding
          - terminated
    Error:
      type: object
      properties:
        code:
          type: string
        message:
          type: string
    EmployeeCreate:
      type: object
      required:
      - firstName
      - lastName
      - email
      - countryOfEmployment
      - employmentType
      properties:
        firstName:
          type: string
        lastName:
          type: string
        email:
          type: string
          format: email
        countryOfEmployment:
          type: string
        employmentType:
          type: string
          enum:
          - eor
          - direct
          - contractor
        startDate:
          type: string
          format: date
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: OAuth 2.0 access token supplied as a Bearer token in the Authorization header. Partner credentials are issued by WorkMotion.