문서 목록 조회하기
문서 목록 조회
"문서 리스트 조회 API" 를 통해 계정이 조회 가능한 문서의 목록을 조회할 수 있습니다.
curl --request GET \
--url 'https://api.modusign.co.kr/documents?offset=0&limit=10' \
--header 'Accept: application/json' \
--header 'Authorization: Basic YWFhOmFhYQ=='
요청시 아래의 쿼리 파라미터를 통해 페이지당 문서수와, 불러올 페이지를 설정할 수 있습니다.
예로 ?offset=320&limit=10
의 파라미터는 33페이지의 10개의 문서를 불러옵니다.
이름 | 기본값 | 최대 값 | 필수 여부 | 설명 |
---|---|---|---|---|
offset | 0 | 없음 | 선택 | 목록을 입력한 값만큼 건너뛰고 불러옵니다. 페이지로 이용 시, 원하는 페이지 수와 페이지당 아이템 갯수를 곱하여 적용할 수 있습니다. |
limit | 10 | 100 | 선택 | 불러올 목록의 아이템 수를 지정할 수 있습니다. 페이지로 이용 시, 페이지당 아이템 갯수를 입력합니다. |
적절한 필터를 이용해야 합니다.
문서 목록을 조회할 때 filter를 이용하여 원하는 결과만 조회할 수 있습니다.
모든 문서 목록을 조회하는 방식은 지양해야 합니다. 필요한 시점에 적절한 필터를 사용하시길 바랍니다.
추후 필터 옵션이 필수사항으로 변경될 수 있습니다.자세한 방법은 filter로 검색하기를 참고하세요.
Updated 9 months ago