API

문서 조회

작성일 2026.03.24 | 수정일 2026.03.25

GET/crm-core/v1/documents/:documentId
Parameters
documentId*— 문서 고유 아이디

특정 문서의 상세 정보를 조회합니다.

Response

NameTypeRequiredDescription
documentIdstring*문서 고유 아이디
accountIdstring*계정 고유 아이디
documentTypeIdstring문서 유형 ID
entityIdstring개체 ID
recordIdstring레코드 ID
templateIdstring템플릿 ID
linkedRecordIdsArray<String>연결 레코드 ID 목록
issueMethodstring*발행 방식
namestring*문서 이름
contentObject문서 내용
htmlContentstringHTML 변환 내용
dataSnapshotObject생성 시점의 변수 데이터 스냅샷
attachmentsArray<Object>첨부 파일 목록
fileIdstring*파일 고유 아이디
fileNamestring*파일 이름
fileSizenumber*파일 크기 (바이트)
mimeTypestring*MIME 타입
urlstring*파일 URL (서명된 URL)
uploadedAtdate*업로드 일시
statusstring*문서 상태 (DRAFT, FINALIZED, ARCHIVED)
issuedAtdate발행 일시
ownerIdstring문서 소유자 멤버 ID
issuedBystring발행자 ID
dateCreateddate*최초 생성 날짜
dateUpdateddate*최근 수정 날짜

Structure

Response Structure
{ "documentId": "DOC20260324090000ABCDEFGHIJKLMNO", "accountId": "24010100001234", "documentTypeId": "DTYPE20260324090000ABCDEFGHIJKLM", "entityId": "ENT20260324090000ABCDEFGHIJKLMNO", "recordId": "REC20260324090000ABCDEFGHIJKLMNO", "templateId": "DTPL20260324090000ABCDEFGHIJKLM", "linkedRecordIds": [ "샘플값" ], "issueMethod": "샘플값", "name": "샘플", "content": { "key": "value" }, "htmlContent": "샘플값", "dataSnapshot": { "key": "value" }, "attachments": [], "ownerId": "MEM20260324090000ABCDEFGHIJKLMNO", "status": "ACTIVE", "issuedAt": "2026-03-24T09:00:00.000Z", "issuedBy": "샘플값", "dateCreated": "2026-03-24T09:00:00.000Z", "dateUpdated": "2026-03-24T09:00:00.000Z" }