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

# 필드 목록 조회

> 비즈니스의 커스텀 필드(`Field`) 목록을 조회합니다. 각 필드는 옵션(`option_set`)을 nested로 포함합니다.

**용도:** 의뢰 생성/수정 시 `field_set[].field_id`로 참조됩니다. 필드 타입(`type`)에 따라 옵션 형태가 달라집니다 (텍스트, 숫자, 단일 선택, 다중 선택 등). 옵션 ID는 단일/다중 선택 타입에서 `value`로 사용됩니다.

**filter:** `OpenapiFieldFilter`로 type 등 필터링 가능.



## OpenAPI

````yaml GET /v1/field
openapi: 3.1.0
info:
  title: pluuug openapi
  version: 1.0.0
  description: >-
    플러그에서 제공하는 REST API의 상세 내용을 확인하고 직접 테스트할 수 있는 인터페이스입니다.<br>이 문서를 통해 API의
    엔드포인트, 요청 및 응답 형식 등을 확인할 수 있습니다.
servers:
  - url: https://openapi.pluuug.com
security: []
paths:
  /v1/field:
    get:
      tags:
        - field
      summary: 커스텀 필드 목록
      description: >-
        비즈니스의 커스텀 필드(`Field`) 목록을 조회합니다. 각 필드는 옵션(`option_set`)을 nested로 포함합니다.


        **용도:** 의뢰 생성/수정 시 `field_set[].field_id`로 참조됩니다. 필드 타입(`type`)에 따라 옵션
        형태가 달라집니다 (텍스트, 숫자, 단일 선택, 다중 선택 등). 옵션 ID는 단일/다중 선택 타입에서 `value`로
        사용됩니다.


        **filter:** `OpenapiFieldFilter`로 type 등 필터링 가능.
      operationId: field_list
      parameters:
        - in: query
          name: category
          schema:
            type: string
            x-spec-enum-id: 42b325aeb76868ae
            title: 카테고리
            x-enumNames:
              - 의뢰
              - 고객
              - 계약
            enum:
              - C
              - CO
              - I
          description: |-
            * `I` - 의뢰
            * `C` - 고객
            * `CO` - 계약
        - name: cursor
          required: false
          in: query
          description: Pagination을 위한 커서
          schema:
            type: string
        - name: page_size
          required: false
          in: query
          description: 한번에 조회할 데이터의 개수 (limit)
          schema:
            type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedOpenapiFieldListList'
          description: ''
      security:
        - ApiKeyAuth: []
          Signature: []
components:
  schemas:
    PaginatedOpenapiFieldListList:
      type: object
      required:
        - results
      properties:
        next:
          type:
            - string
            - 'null'
          format: uri
          example: http://api.example.org/accounts/?cursor=cD00ODY%3D"
        previous:
          type:
            - string
            - 'null'
          format: uri
          example: http://api.example.org/accounts/?cursor=cj0xJnA9NDg3
        results:
          type: array
          items:
            $ref: '#/components/schemas/OpenapiFieldList'
    OpenapiFieldList:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
          readOnly: true
          description: 커스텀 필드 이름
        dataType:
          enum:
            - S
            - 'N'
            - M
            - D
            - T
            - B
            - SL
            - ML
          type: string
          x-spec-enum-id: 382c397735902283
          readOnly: true
          description: |-
            데이터 타입

            * `S` - String
            * `N` - Number
            * `M` - Member
            * `D` - Date
            * `T` - Time
            * `B` - Boolean
            * `SL` - Single List(단수 선택)
            * `ML` - Multi List(복수 선택)
          x-enumNames:
            - String
            - Number
            - Member
            - Date
            - Time
            - Boolean
            - Single List(단수 선택)
            - Multi List(복수 선택)
        optionSet:
          type: array
          items:
            $ref: '#/components/schemas/OpenapiNestedFieldOption'
          readOnly: true
          description: 커스텀 필드 옵션 목록 (단수선택(SL), 복수선택(ML) 타입에서만 데이터 존재)
        memberSet:
          type: array
          items:
            $ref: '#/components/schemas/OpenapiNestedMember'
          readOnly: true
          description: 멤버 목록 (멤버(M) 타입에서만 데이터 존재)
      required:
        - dataType
        - id
        - memberSet
        - name
        - optionSet
    OpenapiNestedFieldOption:
      type: object
      properties:
        id:
          type: string
          readOnly: true
        title:
          type: string
          readOnly: true
      required:
        - id
        - title
    OpenapiNestedMember:
      type: object
      description: |-
        nested 아이템이 제공되면 선언된 required 필드를 모두 가져야 함을 강제한다.

        부모 레벨 partial(미전송 필드 생략)은 유지하되, nested 아이템은 object-level
        validate에서 required 필드 존재를 재확인해 누락 시 400을 반환한다.
      properties:
        id:
          type: integer
        nickname:
          type:
            - string
            - 'null'
          readOnly: true
          description: 닉네임
        email:
          type: string
          readOnly: true
          description: 이메일
        isActive:
          type: boolean
          readOnly: true
          description: 활성화 여부
        grade:
          allOf:
            - $ref: '#/components/schemas/OpenapiNestedMemberGrade'
          readOnly: true
          description: 등급
      required:
        - email
        - grade
        - id
        - isActive
        - nickname
    OpenapiNestedMemberGrade:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        title:
          type: string
          readOnly: true
      required:
        - id
        - title
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
    Signature:
      type: apiKey
      in: header
      name: X-Signature
      description: |-
        HMAC-SHA256 방식으로 body를 secret key로 해싱하여 생성한 서명을 넣어야 합니다.
        서버는 X-API-Key와 대응되는 secret key로 서명을 검증합니다.

````