해당 API 키를 발급한 모아폼 계정에 속하는 모든 설문(공동작업 설문 포함)의 목록을 JSON형태로 가져옵니다.
[GET] https://api.moaform.com/v1/forms
요청
Query Parameters
| Key | Type | Description |
|---|---|---|
| search | string | 제목으로 설문을 검색 |
| page | integer | 가져올 목록의 페이지. 기본값 1 |
| page_size | integer | 페이지당 가져올 목록의 개수. 기본값 25, 최대값 1000 |
| sort_by | string | 목록을 정렬할 필드. 기본값은 created_at (created_at, last_updated_at 중 하나) |
| order_by | string | 정렬할 순서. 기본값은 asc (오름차순 정렬 asc, 내림차순 정렬 desc 중 하나) |
응답
| Key | Type | Description |
|---|---|---|
| total_items | integer | 설문 목록의 전체 개수 |
| page_count | integer | 페이지 개수 |
| items | [object] | |
| ↳ long_id | string | 설문의 고유 ID |
| ↳ id | string | long_id가 공식적인 설문 ID입니다. 과거 버전과의 호환성을 위해 id도 한시적으로 동작하지만, 앞으로 지원이 중단될 예정입니다. 가능한 long_id를 사용해 주세요. |
| ↳ name | string | 설문 파일 이름 |
| ↳ status | string | 설문 진행 상태 (editing, pending, collecting, closed 중 하나) |
| ↳ collection | object | |
| ↳ responses_count | integer | 수집된 답변 수 |
| ↳ start_at | string | 답변수집 시작 시간. 시작되지 않은 경우 null |
| ↳ end_at | string | 답변수집 종료 시간. 종료되지 않은 경우 null |
| groups | [string] | group 타이틀 |
| links | [object] | |
| ↳ self | string | api endpoint link |
| ↳ report_url | string | 결과보기 link |
| ↳ answer_url | string | 답변 link |
| owned | boolean | 설문의 소유자 여부 |
| last_responsed_at | string | 마지막 답변 일시 |
| created_at | string | 설문 생성 일시 |
| last_updated_at | string | 설문 최종 수정 일시 |