메인 콘텐츠로 건너뛰기
GET
cURL

인증

Authorization
string
header
필수

Settings → Developers에서 발급한 키를 Authorization: Bearer dr_live_<12자리 16진수>_<64자리 16진수> 형태로 전송합니다. 키는 명시적인 범위를 가지며 — 각 엔드포인트에 필요한 범위가 해당 엔드포인트에 명시되어 있습니다. 전체 키는 발급 시점에 딱 한 번만 표시되며 다시 조회할 수 없습니다 — 이후에는 keyId 접두어만 표시됩니다. 폐기된 키는 바로 다음 요청부터 인증에 실패합니다.

경로 매개변수

id
string<uuid>
필수

문서 ID입니다.

응답

문서입니다.

DocumentSummary에 설명, 만료 정보, 두 허용 목록이 포함된 보호 방식 요약, revision을 더한 것입니다. status는 방문자가 실제로 겪는 상태입니다(목록의 값과 같으며 expired를 포함합니다). 성공한 PATCH /api/preview/documents/{id}가 반환하는 본문이기도 합니다.

id
string<uuid>
필수

문서의 id입니다.

title
string
필수

문서 제목입니다.

kind
enum<string>
필수

문서가 무엇으로 이루어져 있는지 나타냅니다: notion, pdf, upload(업로드한 파일), post, form.

사용 가능한 옵션:
notion,
pdf,
upload,
post,
form
status
enum<string>
필수

상태입니다. live(공개 중, 방문자가 열 수 있음), draft(초안, 아직 게시하지 않은 포스트나 폼), inactive(비활성, 직접 껐거나 Notion 페이지를 더 이상 읽을 수 없는 등의 이유로 자동으로 꺼짐), expired(만료, 만료일이 지남) 중 하나입니다.

사용 가능한 옵션:
live,
draft,
inactive,
expired
url
string<uri>
필수

공개 공유 링크입니다.

createdAt
string<date-time>
필수

문서를 만든 시각(RFC 3339, UTC)입니다.

updatedAt
string<date-time>
필수

문서를 마지막으로 바꾼 시각(RFC 3339, UTC)입니다.

expiresAt
string<date-time> | null
필수

고정 만료일이며, 없으면 null입니다. 열람자별(상대) 만료는 단일 날짜가 없으므로 여기서는 null입니다. 단일 문서 응답의 expiry를 확인하세요.

description
string | null
필수

문서의 부제목이며, 설정하지 않았으면 null입니다.

expiry
object
필수

문서가 만료되는 시점입니다.

protection
object
필수

문서가 어떻게 보호되는지입니다. 이메일과 허용 목록 필드는 PATCH로 변경하며, 비밀번호와 접근 방식은 여기서 읽기 전용입니다. 비밀번호는 포함되지 않습니다.

revision
string
필수

이 설정의 버전을 나타냅니다(밀리초 단위의 ISO 8601 UTC 타임스탬프). ETag 헤더로도 전달되며, PATCH할 때 본문의 revision으로 그대로 보내세요. 값의 의미는 해석하지 말고 그대로 사용하세요.