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

# List pipeline fields

> The field definitions of one pipeline. Entry `values` are keyed by each field's `fieldId` —
read these to know which keys an entry accepts and how to render them (`label`, `type`).

Scoped by { project, targetSource: 'PIPELINE', pipeline } so it never leaks another
pipeline's — or a session / company / ticket's — properties. The Frontend needs it to map the
pipeline's columns (which store propertyId) onto entry.values (which is keyed by fieldId).



## OpenAPI

````yaml https://api.gleap.io/api-docs.json get /pipelines/{pipelineId}/properties
openapi: 3.0.0
info:
  title: gleap-server
  version: 14.0.0
  contact: {}
servers:
  - url: https://api.gleap.io/v3
security: []
paths:
  /pipelines/{pipelineId}/properties:
    get:
      tags:
        - Pipelines
      summary: List pipeline fields
      description: >-
        The field definitions of one pipeline. Entry `values` are keyed by each
        field's `fieldId` —

        read these to know which keys an entry accepts and how to render them
        (`label`, `type`).


        Scoped by { project, targetSource: 'PIPELINE', pipeline } so it never
        leaks another

        pipeline's — or a session / company / ticket's — properties. The
        Frontend needs it to map the

        pipeline's columns (which store propertyId) onto entry.values (which is
        keyed by fieldId).
      operationId: PipelineProperties
      parameters:
        - in: path
          name: pipelineId
          required: true
          schema:
            type: string
        - in: header
          name: project
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                items:
                  allOf:
                    - properties:
                        updatedAt:
                          $ref: '#/components/schemas/NativeDate'
                        createdAt:
                          $ref: '#/components/schemas/NativeDate'
                      required:
                        - updatedAt
                        - createdAt
                      type: object
                    - properties:
                        visability:
                          properties:
                            sharedDetail:
                              type: boolean
                            sharedSidebar:
                              type: boolean
                            card:
                              type: boolean
                            detail:
                              type: boolean
                            sidebar:
                              type: boolean
                            create:
                              type: boolean
                          required:
                            - sharedDetail
                            - sharedSidebar
                            - card
                            - detail
                            - sidebar
                            - create
                          type: object
                        pipeline:
                          $ref: '#/components/schemas/ObjectId'
                        isSystem:
                          type: boolean
                        onlyShowWhenDataIsSet:
                          type: boolean
                        readOnly:
                          type: boolean
                        currency:
                          type: string
                        restrictions:
                          type: string
                        labelIcon:
                          type: string
                        project:
                          $ref: '#/components/schemas/ObjectId'
                        validation:
                          type: string
                        placeholder: {}
                        path:
                          type: string
                        required:
                          type: boolean
                        targetSource:
                          type: string
                        fieldId:
                          type: string
                        label:
                          type: string
                        options:
                          items:
                            properties:
                              type:
                                properties:
                                  value:
                                    type: string
                                  label: {}
                                  icon:
                                    type: string
                                type: object
                            type: object
                          type: array
                        type:
                          type: string
                      required:
                        - targetSource
                        - fieldId
                        - label
                        - options
                        - type
                      type: object
                    - $ref: '#/components/schemas/Document_any.any.any_'
                    - properties:
                        _id:
                          $ref: '#/components/schemas/ObjectId'
                      required:
                        - _id
                      type: object
                type: array
      security:
        - jwt: []
components:
  schemas:
    NativeDate:
      type: string
    ObjectId:
      type: string
    Document_any.any.any_:
      $ref: '#/components/schemas/FlattenMaps_T_'
      description: >-
        Generic types for Document:

        *  T - the type of _id

        *  TQueryHelpers - Object with any helpers that should be mixed into the
        Query type

        *  DocType - the type of the actual Document created
    FlattenMaps_T_:
      properties: {}
      type: object
  securitySchemes:
    jwt:
      type: http
      scheme: bearer
      bearerFormat: JWT

````