---
title: "문서 리스트 조회"
method: GET
path: "/documents"
tags: ["USER API"]
---

# 문서 리스트 조회

`GET /documents`

## Query parameters

- `offset` number
- `limit` number
- `metadatas` string
- `filter` string
- `orderBy` string

## Response `200`

- GetDocumentsResponseDto
  - `count` number, required — 전체 개수
  - `documents` GetDocumentsResponseDocumentDto[], required — 문서 목록
    - `id` string, required — 문서 ID
    - `title` string, required — 문서 제목
    - `status` 'ON_GOING' | 'MODIFYING' | 'APPROVAL_PENDING' | 'DRAFT' | 'ON_PROCESSING' | 'PROCESSING_FAILED' | 'ABORTED' | 'COMPLETED' | 'SCHEDULED', required — 문서 상태: * `DRAFT` - 작성 중* `SCHEDULED` - 전송 예약 중 * `ON_GOING` - 서명/열람 진행 중 * `MODIFYING` - 수정 중 * `APPROVAL_PENDING` - 결재 대기 중 * `ON_PROCESSING` - 문서 처리 중 * `PROCESSING_FAILED` - 문서 처리 실패 * `ABORTED` - 서명/열람 중단됨 * `COMPLETED` - 모든 서명/열람 완료
    - `requester` RequesterInDocumentResponseDto, required
      - `email` string, required — 요청자 이메일
      - `name` string, required — 요청자 이름
    - `participants` union[], required — 참여자 리스트
      - union
        - SignerInDocumentResponseDto
          - `id` string, required — 참여자 ID
          - `type` 'SIGNER' | 'VIEWER', required — 참여자 타입
          - `name` string, required — 참여자 이름
          - `signingOrder` number, required — 참여자의 참여 순서
          - `signingDue` SigningDueInDocumentResponseDto, required
            - `valid` boolean, required — 현재 참여 가능 여부
            - `datetime` string, date-time, nullable, required — 참여자의 참여 유효일
          - `signingMethod` SigningMethodInDocumentResponseDto, required
            - `type` 'EMAIL' | 'KAKAO' | 'SECURE_LINK' | 'IN_PERSON', required — 참여 수단 종류
            - `value` string, required — 참여 수단 값
          - `locale` 'ko' | 'en' | 'zh-CN' | 'ja' | 'vi', required — 참여자가 사용할 언어
        - ViewerInDocumentResponseDto
          - `id` string, required — 참여자 ID
          - `type` 'VIEWER', required — 참여자 타입
          - `name` string, required — 참여자 이름
          - `signingOrder` number, required — 참여자의 참여 순서
          - `signingDue` SigningDueInDocumentResponseDto, required
            - `valid` boolean, required — 현재 참여 가능 여부
            - `datetime` string, date-time, nullable, required — 참여자의 참여 유효일
          - `signingMethod` SigningMethodInDocumentResponseDto, required
            - `type` 'EMAIL' | 'KAKAO' | 'SECURE_LINK' | 'IN_PERSON', required — 참여 수단 종류
            - `value` string, required — 참여 수단 값
          - `locale` 'ko' | 'en' | 'zh-CN' | 'ja' | 'vi', required — 참여자가 사용할 언어
          - `manuallyViewing` boolean, required — 상세 열람 여부
    - `currentSigningOrder` integer, required — 현재 참여 차례
    - `signings` SigningInDocumentResponseDto[], required — 입력된 서명, 열람 완료된 참여자 리스트
      - `participantId` string, required — 참여한 참여자 ID
      - `signedAt` string, date-time, required — 참여한 시간
    - `accessibleByParticipant` boolean, required — 문서 중단 시 요청자 외의 참여자들의 문서 파일 접근 가능 여부
    - `abort` AbortInDocumentResponseDto, required
      - `type` 'REJECTION' | 'SIGNING_CANCELLATION' | 'REQUEST_CANCELLATION', required — 중단 종류: * `REJECTION` - 거절됨 * `SIGNING_CANCELLATION` - 참여 취소됨 * `REQUEST_CANCELLATION` - 요청 취소됨
      - `message` string, required — 중단 사유
      - `abortedAt` string, date-time, required — 중단 시점
      - `participantId` string, nullable, required — 중단한 참여자 ID (거절 또는 참여 취소 시)
    - `updatedAt` string, date, required — 마지막 업데이트 시간
    - `createdAt` string, date, required — 문서 생성 시간
    - `startedAt` string, date, nullable, required — 참여 요청 시간
    - `file` PdfFileInDocumentResponseDto, required
      - `downloadUrl` string, required — 다운로드 링크(유효시간: 10분)
    - `auditTrail` AuditTrailInDocumentResponseDto, required
      - `downloadUrl` string, required — 다운로드 링크(유효시간: 10분)
      - `locales` AuditTrailLocale[], required — 감사추적인증서 제공 언어
    - `seal` DocumentSealInDocumentResponseDto, required
      - `integritySeal` IntegritySealInDocumentResponseDto, required
        - `enabled` boolean, required — 진본 증명 도장 활성화 여부
        - `position` 'TOP_LEFT' | 'TOP_RIGHT' | 'BOTTOM_LEFT' | 'BOTTOM_RIGHT', required — 진본 증명 도장 위치
    - `metadatas` MetadataDtoInDocumentResponseDto[], required — 메타데이터 리스트(응답의 메타데이터는 순서가 보장되지 않습니다)
      - `key` string, required — 메타 데이터 키
      - `value` string, required — 메타 데이터 값
    - `labels` LabelDtoInDocumentResponseDto[], required — 라벨 리스트(응답의 라벨은 순서가 보장되지 않습니다)
      - `id` string, required — 라벨 ID
      - `name` string, required — 라벨 이름
      - `description` string, nullable, required — 라벨의 설명

---

[API](https://skmtc.net/modusign/apis/modusign-api.md) · [All operations](https://skmtc.net/modusign/apis/modusign-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/modusign/modusign-api/versions/5772e872cbf9/schema)