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

# List custom fields

> Returns the organisation's active custom field definitions in display order. `key` is the key a package's `metadata` uses. `scope` is `all` for a field on every package, or `templates` for a field only on packages launched from one of `templateIds`. `templateId` narrows the list to the fields a package launched from that template carries. `isRequired` fields MUST be filled before a package is sent. A plan without custom fields answers 402.



## OpenAPI

````yaml /api-reference/openapi.json get /api/v1/custom-fields
openapi: 3.0.3
info:
  title: Flowsign API
  version: 1.0.0
  description: >-
    Public v1 API for Flowsign. Every endpoint is authenticated with a Bearer
    API key (prefix `fsk_`). Errors use `{ error, details? }`; success responses
    wrap payload data as `{ data }`.


    An organisation is divided into workspaces. A key belongs to the
    organisation and acts in one workspace per request: pass `X-Workspace-Id`
    (see `GET /api/v1/workspaces`) or omit it to act in the default workspace.
    Packages, templates, contacts and members are scoped to the workspace the
    call acts in.
servers:
  - url: https://my.flowsign.app
    description: Production
security:
  - ApiKey: []
paths:
  /api/v1/custom-fields:
    get:
      tags:
        - Custom fields
      summary: List custom fields
      description: >-
        Returns the organisation's active custom field definitions in display
        order. `key` is the key a package's `metadata` uses. `scope` is `all`
        for a field on every package, or `templates` for a field only on
        packages launched from one of `templateIds`. `templateId` narrows the
        list to the fields a package launched from that template carries.
        `isRequired` fields MUST be filled before a package is sent. A plan
        without custom fields answers 402.
      operationId: getCustom-fields
      parameters:
        - schema:
            type: string
            minLength: 1
          required: false
          name: templateId
          in: query
        - schema:
            type: string
            description: >-
              The workspace to act in, from `GET /api/v1/workspaces`. Omit to
              act in the organisation's default workspace. A workspace the key's
              user cannot act in is treated as omitted.
          required: false
          name: x-workspace-id
          in: header
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        key:
                          type: string
                        label:
                          type: string
                        helpText:
                          type: string
                          nullable: true
                        isRequired:
                          type: boolean
                        scope:
                          type: string
                          enum:
                            - all
                            - templates
                        templateIds:
                          type: array
                          items:
                            type: string
                        order:
                          type: integer
                      required:
                        - key
                        - label
                        - helpText
                        - isRequired
                        - scope
                        - templateIds
                        - order
                required:
                  - data
        '401':
          description: Missing or invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '402':
          description: Caller's plan does not include this feature (publicApi / webhooks)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: API key present but caller lacks the required permission
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          description: Request failed schema validation; details keyed by field
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Rate limit exceeded; see `Retry-After`
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    Error:
      type: object
      properties:
        error:
          type: string
        details:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
      required:
        - error
  securitySchemes:
    ApiKey:
      type: http
      scheme: bearer
      bearerFormat: fsk_*

````