> ## 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.

# List organization article fields

> Returns the unified article-fields view: the canonical default fields with the organization's enabled/disabled state, and the organization's custom article field definitions ordered by sortOrder.



## OpenAPI

````yaml GET /api/v1/organization/article-fields
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:
    get:
      summary: List organization article fields
      description: >-
        Returns the unified article-fields view: the canonical default fields
        with the organization's enabled/disabled state, and the organization's
        custom article field definitions ordered by sortOrder.
      operationId: listOrganizationArticleFields
      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/OrganizationArticleFieldsView'
        '401':
          description: Missing or invalid authentication, or no organization context.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    OrganizationArticleFieldsView:
      type: object
      description: >-
        The unified article-fields view: canonical default fields in catalog
        order, then the organization's custom field definitions in sort order.
      required:
        - defaultFields
        - customFields
      properties:
        defaultFields:
          type: array
          items:
            $ref: '#/components/schemas/DefaultArticleField'
        customFields:
          type: array
          items:
            $ref: '#/components/schemas/OrganizationArticleField'
    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
    DefaultArticleField:
      type: object
      description: >-
        One canonical (default) article field with the organization's
        enabled/disabled state. Identity is the catalog source; labels and
        descriptions are human-facing display copy.
      required:
        - source
        - label
        - description
        - fieldKind
        - isAlwaysIncluded
        - isEnabled
        - revision
      properties:
        source:
          type: string
          description: Stable identity of the field in the canonical catalog.
          example: excerpt
        label:
          type: string
          description: Human-facing display label.
          example: Excerpt
        description:
          type: string
          description: Concise human explanation of what the field is for.
        fieldKind:
          type: string
          description: The field's value kind.
          example: string
        isAlwaysIncluded:
          type: boolean
          description: >-
            True for fields that are part of every article and cannot be
            disabled (Title, Main body).
        isEnabled:
          type: boolean
          description: Whether newly generated articles include the field.
        revision:
          type: integer
          description: >-
            Optimistic-concurrency revision a toggle must carry; 0 when the
            field has never been toggled.
    OrganizationArticleField:
      type: object
      description: An organization-defined custom article output field definition.
      required:
        - id
        - key
        - label
        - fieldType
        - required
        - options
        - isActive
        - sortOrder
        - revision
        - createdAtUtc
        - updatedAtUtc
      properties:
        id:
          type: string
          format: uuid
        key:
          type: string
          description: Backend-generated stable internal key. Immutable after creation.
          pattern: ^[a-z][a-zA-Z0-9]{1,63}$
        label:
          type: string
          maxLength: 120
        fieldType:
          type: string
          enum:
            - string
            - text
            - number
            - boolean
            - select
            - multiselect
            - date
            - url
          description: Allowlisted field type. Immutable after creation.
        required:
          type: boolean
        description:
          type:
            - string
            - 'null'
          maxLength: 500
        generationInstruction:
          type:
            - string
            - 'null'
          maxLength: 500
          description: Bounded instruction rendered to the model during generation.
        options:
          type: array
          items:
            type: object
            required:
              - label
              - value
            properties:
              label:
                type: string
                maxLength: 200
              value:
                type: string
                maxLength: 200
        defaultValue:
          description: Default value validated against the field type and options.
        isActive:
          type: boolean
        sortOrder:
          type: integer
        revision:
          type: integer
          description: >-
            Optimistic-concurrency revision. Send it back as expectedRevision on
            writes; a stale value yields 409.
        createdAtUtc:
          type: string
          format: date-time
        updatedAtUtc:
          type: string
          format: date-time
  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.