generated: '2026-07-21'
method: derived
source: openapi/work-market-employer-api-openapi.yml
docs: https://developer.workmarket.com/page/best-practices
description: >-
  Cross-cutting request/response semantics of the WorkMarket Employer API,
  derived from the published Swagger 2.0 spec and the developer portal.
authentication:
  style: access token exchanged from API token/secret, sent as Authorization Bearer header
  reference: authentication/work-market-authentication.yml
idempotency:
  supported: false
  notes: >-
    No idempotency-key header or parameter is documented anywhere in the spec
    or docs.
pagination:
  style: offset
  request_params: [start, limit]
  notes: List operations (e.g. listAssignmentsAction) accept start/limit query parameters.
response_envelope:
  shape: >-
    Every response wraps the payload as {meta, response}. meta (v1Meta)
    carries status_code, requestId, version, execution_time, timestamp, and
    an errors[] array; response carries the operation payload.
  error_reference: errors/work-market-problem-types.yml
request_tracing:
  field: meta.requestId
  notes: Request id is returned in the response meta envelope, not documented as a request header.
versioning:
  style: uri-path (v1)
  reference: lifecycle/work-market-lifecycle.yml
rate_limits:
  documented: false
  notes: No rate-limit headers or quotas are documented on the public portal.
field_expansion:
  supported: false
metadata:
  custom_fields: >-
    Custom fields (per-assignment key/values, managed via the Custom Fields
    endpoints) are the platform's extension mechanism; webhook variables can
    reference them as custom_field_<id>.
webhooks:
  reference: asyncapi/work-market-webhooks.yml