메인 콘텐츠로 건너뛰기

기본 주소

엔드포인트는 모두 /v1/로 시작합니다.

헤더

응답

성공 응답의 맨 위에는 요청마다 다른 request_id가 있습니다. 문의할 때 이 값을 알려 주세요. 이 문서의 응답 예제는 예시 값을 사용합니다.

오류

오류 응답의 형식은 다음과 같습니다. additional_data는 있을 때만 포함됩니다.
서버는 경로와 메서드 → JSON → 인증 → 버전 → 본문 값 순서로 검사합니다.

목록 읽기

목록 응답의 형식은 다음과 같습니다.
  • page_size는 1~100이고 기본값은 100입니다.
  • has_more가 true면 next_cursor를 다음 요청의 start_cursor로 보내세요.
  • 커서는 그 쿼리에서만 사용할 수 있습니다. 필터나 정렬이 다른 쿼리에 보내면 400입니다.

ID

데이터베이스와 데이터 소스는 ID가 같습니다. 속성 ID와 선택지 ID는 데이터 소스 읽기 응답에서 확인할 수 있습니다. 경로와 관계의 ID는 형식을 검사하지 않습니다. 형식이 틀린 ID도 없는 ID와 같이 404를 반환합니다.

시각

created_time과 last_edited_time은 UTC이고 분 단위로 잘립니다. created_time과 last_edited_time 필터도 이 값으로 비교합니다. 수식의 now()와 날짜 필터의 오늘 · 이번 주도 UTC로 계산합니다.

예약된 사용자 ID

created_by와 last_edited_by에는 다음 값이 올 수 있습니다.

속성 고르기

POST /v1/data_sources/{id}/query · GET /v1/pages/{id} · POST /v1/search는 쿼리 문자열 filter_properties를 받습니다. 속성 이름이나 ID를 반복해 넣으면 그 속성만 응답에 담습니다. filter_properties[]로 써도 됩니다.
모르는 속성을 넣으면 쿼리와 페이지 읽기는 400 Could not find property with name or id: ...이고, 검색은 건너뜁니다. 하위 문서에는 제목만 있습니다.

파일 주소

파일 속성 · 파일 블록 · 올린 그림 아이콘과 표지의 주소는 서명 주소이고 1시간 뒤 만료됩니다. expiry_time을 확인하고, 지나면 다시 읽어 새 주소를 받으세요.

없는 엔드포인트

다음 엔드포인트는 없습니다. 호출하면 400 invalid_request_url을 반환합니다. 파일 · 아이콘 · 표지에 file_upload를 보내면 404입니다. GET /v1/users/me의 max_file_upload_size_in_bytes는 0입니다.