> ## Documentation Index
> Fetch the complete documentation index at: https://docs.weelkit.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Preview the effective contract

> Compiles the canonical catalog plus the organization's active custom fields, with the stable schema fingerprint used at generation time.



## OpenAPI

````yaml GET /api/v1/organization/article-fields/effective-contract
openapi: 3.1.0
info:
  title: Weelkit Publishing Integrations API
  description: >-
    Public endpoints for organization custom article fields, API webhook
    destinations, and WordPress.com site discovery. All requests require a
    bearer token and an X-Org-Id organization header.
  version: 1.0.0
servers:
  - url: https://api.weelkit.com
security:
  - bearerAuth: []
paths:
  /api/v1/organization/article-fields/effective-contract:
    get:
      summary: Preview the effective article contract
      description: >-
        Compiles the canonical catalog plus the organization's active custom
        fields, with the stable schema fingerprint used at generation time.
      operationId: getEffectiveArticleContract
      parameters:
        - name: X-Org-Id
          in: header
          required: true
          schema:
            type: string
            format: uuid
          description: The organization the request acts on.
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EffectiveOrganizationArticleContract'
        '401':
          description: Missing or invalid authentication, or no organization context.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    EffectiveOrganizationArticleContract:
      type: object
      required:
        - schemaFingerprint
        - organizationFieldRevision
        - activeOrganizationFieldCount
        - contract
        - fieldLabels
      properties:
        schemaFingerprint:
          type: string
          description: >-
            weelkit-platform-article.v3 for the recommended organization preset,
            with selection and organization-field suffixes when configured.
        organizationFieldRevision:
          type: integer
        activeOrganizationFieldCount:
          type: integer
        contract:
          type: object
          required:
            - contractVersion
            - canonicalCatalogVersion
            - providerSlug
            - contentTypeId
            - fields
          properties:
            contractVersion:
              type: integer
            canonicalCatalogVersion:
              type: integer
            providerSlug:
              type: string
            contentTypeId:
              type: string
            fields:
              type: array
              items:
                $ref: '#/components/schemas/ArticleOutputContractField'
        fieldLabels:
          type: object
          description: >-
            Display name for each field and property source in the contract: the
            catalog label for a default field, the saved name for a custom
            field. A source without a name is absent. Presentation only; it is
            not part of the contract the engine receives.
          additionalProperties:
            type: string
    Error:
      type: object
      required:
        - code
        - message
      properties:
        code:
          type: string
          description: Stable error code, e.g. Validation, Conflict, NotFound, Forbidden.
        message:
          type: string
        errors:
          type:
            - array
            - 'null'
          items:
            type: object
            required:
              - field
              - message
            properties:
              field:
                type: string
              message:
                type: string
    ArticleOutputContractField:
      type: object
      description: >-
        One field of the canonical article output contract, exactly as
        serialized by the API.
      required:
        - source
        - outputPath
        - type
        - normalizedType
        - shape
        - required
        - description
        - instruction
        - allowedOptions
        - defaultValue
        - referenceTarget
        - referenceSelectionPolicy
        - defaultReferenceOptionId
        - generationOwner
        - children
        - bindings
      properties:
        source:
          type: string
        outputPath:
          type: string
        type:
          type: string
        normalizedType:
          type: string
        shape:
          description: Structural shape metadata; null for flat fields.
        required:
          type: boolean
        description:
          type: string
        instruction:
          type: string
        allowedOptions:
          type: array
          items:
            type: object
            required:
              - label
              - value
            properties:
              label:
                type: string
                maxLength: 200
              value:
                type: string
                maxLength: 200
        defaultValue:
          description: Configured default value; null when absent.
        referenceTarget:
          type:
            - string
            - 'null'
        referenceSelectionPolicy:
          type:
            - string
            - 'null'
        defaultReferenceOptionId:
          type:
            - string
            - 'null'
          format: uuid
        generationOwner:
          type: string
          enum:
            - ai
            - backend
        children:
          type: array
          items:
            $ref: '#/components/schemas/ArticleOutputContractField'
        bindings:
          type: array
          items:
            description: Provider binding metadata for schema-backed destinations.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Weelkit access token.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.