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

# 고객 목록 조회

> 비즈니스의 고객 목록을 최신순(`created` DESC)으로 조회합니다.

**검색:** `search` 쿼리 파라미터는 복수 전달 시 AND 결합으로 동작합니다 (예: `?search=A&search=B`는 회사명/담당자/연락처/이메일 중 A·B 모두 포함하는 고객만 반환).

**filter:** `OpenapiClientFilter`로 status 등 필터링 가능.



## OpenAPI

````yaml GET /v1/client
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/client:
    get:
      tags:
        - client
      summary: 고객 목록
      description: >-
        비즈니스의 고객 목록을 최신순(`created` DESC)으로 조회합니다.


        **검색:** `search` 쿼리 파라미터는 복수 전달 시 AND 결합으로 동작합니다 (예:
        `?search=A&search=B`는 회사명/담당자/연락처/이메일 중 A·B 모두 포함하는 고객만 반환).


        **filter:** `OpenapiClientFilter`로 status 등 필터링 가능.
      operationId: client_list
      parameters:
        - in: query
          name: created_end
          schema:
            type: string
            format: date
          description: 생성일 종료 (YYYY-MM-DD)
        - in: query
          name: created_start
          schema:
            type: string
            format: date
          description: 생성일 시작 (YYYY-MM-DD)
        - name: cursor
          required: false
          in: query
          description: Pagination을 위한 커서
          schema:
            type: string
        - in: query
          name: is_hidden
          schema:
            type: boolean
          description: '숨김 처리 여부 필터 (true: 숨김 항목만, false: 비숨김 항목만, 미전달: 전체)'
        - name: page_size
          required: false
          in: query
          description: 한번에 조회할 데이터의 개수 (limit)
          schema:
            type: integer
        - in: query
          name: search
          schema:
            type: array
            items:
              type: string
          description: 검색어 (복수 전달 시 AND 결합). 회사명/담당자/연락처/이메일에 대해 부분 일치(icontains).
          explode: true
        - in: query
          name: status_id
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedOpenapiClientListCreateList'
          description: ''
      security:
        - ApiKeyAuth: []
          Signature: []
components:
  schemas:
    PaginatedOpenapiClientListCreateList:
      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/OpenapiClientListCreate'
    OpenapiClientListCreate:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        status:
          description: 고객 상태 (미입력 시 기본 상태)
          oneOf:
            - type: 'null'
            - $ref: '#/components/schemas/OpenapiNestedClientStatus'
        companyName:
          type: string
          description: 회사명
          maxLength: 128
        inCharge:
          type:
            - string
            - 'null'
          description: 담당자
          maxLength: 64
        position:
          type:
            - string
            - 'null'
          description: 직책
          maxLength: 64
        contact:
          type:
            - string
            - 'null'
          description: 연락처
          maxLength: 128
        email:
          type:
            - string
            - 'null'
          format: email
          description: 이메일
          maxLength: 128
        created:
          type: string
          format: date-time
          readOnly: true
          description: 생성일시
      required:
        - companyName
        - created
        - id
    OpenapiNestedClientStatus:
      type: object
      description: |-
        nested 아이템이 제공되면 선언된 required 필드를 모두 가져야 함을 강제한다.

        부모 레벨 partial(미전송 필드 생략)은 유지하되, nested 아이템은 object-level
        validate에서 required 필드 존재를 재확인해 누락 시 400을 반환한다.
      properties:
        id:
          type: integer
        title:
          type: string
          readOnly: true
          description: 상태 제목
      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로 서명을 검증합니다.

````