orderBy 파라미터를 사용하면 문서 리스트 조회 API의 결과를 원하는 기준과 방향으로 정렬할 수 있습니다. 정렬 구문을 작성한 뒤 URL 인코딩하여 orderBy 파라미터에 적용해 주세요.

📘
시작하기 전에 꼭 이해하기

orderBy를 생략하면 **최근 활동일 내림차순(updatedAt desc)**으로 정렬됩니다.

orderBy는 문서 리스트 조회에서 사용할 수 있습니다. 템플릿 리스트 조회 API에는 orderBy 파라미터가 없습니다.

목록 조회의 기본 사용법은 문서 목록 조회하기를, 조건 검색은 filter로 검색하기를 참고하세요.

1. 기본 사용법

정렬 구문은 {정렬 기준} {정렬 방향} 형식으로 작성합니다.

정렬 기준	설명
`createdAt`	문서 생성일
`updatedAt`	최근 활동일
`title`	문서 제목

정렬 방향	설명
`asc`	오름차순
`desc`	내림차순

curl의 --data-urlencode를 사용하면 구문을 그대로 적어도 자동으로 인코딩됩니다.

curl --get 'https://api.modusign.co.kr/documents' \
  -H 'Accept: application/json' \
  -H 'Authorization: Basic {인코딩된 API-KEY}' \
  --data-urlencode 'offset=0' \
  --data-urlencode 'limit=10' \
  --data-urlencode 'orderBy=createdAt asc'

직접 인코딩하는 경우 공백을 %20으로 변환합니다.

구문	인코딩 결과	결과
`createdAt asc`	`createdAt%20asc`	생성일이 오래된 문서부터
`updatedAt desc`	`updatedAt%20desc`	최근 활동한 문서부터 (기본값)
`title asc`	`title%20asc`	제목 오름차순

예를 들어 &orderBy=createdAt%20asc를 적용하면 생성일이 오래된 문서부터 불러옵니다.

2. filter와 함께 사용하기

orderBy는 filter와 함께 사용할 수 있습니다. 아래는 지난달 생성된 문서 중 완료된 문서를 생성일 순으로 불러오는 예시입니다.

curl --get 'https://api.modusign.co.kr/documents' \
  -H 'Accept: application/json' \
  -H 'Authorization: Basic {인코딩된 API-KEY}' \
  --data-urlencode 'offset=0' \
  --data-urlencode 'limit=100' \
  --data-urlencode "filter=status eq 'COMPLETED' and createdAt ge '2026-09-01T00:00:00+09:00' and createdAt le '2026-09-30T23:59:59+09:00'" \
  --data-urlencode 'orderBy=createdAt asc'

필터 구문은 filter로 검색하기를 참고하세요.

3. 자주 묻는 질문

orderBy를 넣지 않으면 어떤 순서로 조회되나요?

최근 활동일 내림차순(updatedAt desc)으로 정렬됩니다.

템플릿 목록도 정렬할 수 있나요?

템플릿 리스트 조회 API에는 orderBy 파라미터가 없습니다. 템플릿 리스트 조회에서는 제목 필터와 메타데이터로 조회 대상을 좁힐 수 있습니다.

👍
더 자세한 API 내용은 API References에서 확인하세요!
문서 리스트 조회 의 자세한 내용을 확인하세요.

🚧
유의사항

정렬 구문은 URL 인코딩하여 전달하세요. 공백은 %20으로 변환합니다.

정렬 기준은 createdAt, updatedAt, title 세 가지입니다.

orderBy를 생략하면 updatedAt desc로 정렬됩니다.