Appearance
발급이력 목록 조회
GET
/badges/history
API 키 기관의 발급이력을 이름·이메일·발급 당시 제목·템플릿 ID·상태·발급 요청일·발급일·회수 요청일로 조회합니다. 기본 정렬은 reg_date desc, badge_id desc이며 sort·order로 변경합니다. sort_by·sort_type은 무시합니다.
Authorizations
ApiKeyAuth
Type
API Key (header: X-API-Key)
요청 파라미터
| 필드명 | 위치 | 타입 | 필수 여부 | 기본값 | 설명 |
|---|---|---|---|---|---|
page | query | integer | Optional | 1 | 조회할 페이지 번호 (미전달 시 1) |
rows_per_page | query | integer | Optional | 20 | 페이지당 항목 수 (미전달 시 20, 최대 100) |
sort | query | string | Optional | reg_date | 정렬 기준(기본 reg_date). 동률은 badge_id를 같은 방향으로 정렬합니다. 선택한 issued_at·revoke_at의 null은 방향과 관계없이 마지막입니다. (reg_date, issued_at, revoke_at) |
order | query | string | Optional | desc | 정렬 방향(기본 desc). (asc, desc) |
recipient_name | query | string | Optional | - | 수령인 이름 필터 |
recipient_email | query | string | Optional | - | 수령인 이메일 필터 |
title | query | string | Optional | - | 배지 제목 필터(부분 일치). |
template_id | query | string | Optional | - | 배지 템플릿 ID 필터. |
status_cd | query | string | Optional | - | 발급 상태 필터. ISSUING(발급중), ISSUED(발급완료), REVOKING(회수중), REVOKED(회수완료). (ISSUING, ISSUED, REVOKING, REVOKED) |
issue_start_date | query | string · date | Optional | - | 발급 시작일(issued_at, yyyy-MM-dd). 발급 요청일과 구분합니다. |
issue_end_date | query | string · date | Optional | - | 발급 종료일(issued_at, yyyy-MM-dd). 당일까지 포함합니다. |
revoke_start_date | query | string · date | Optional | - | 회수 요청 시작일(revoke_at, yyyy-MM-dd). |
revoke_end_date | query | string · date | Optional | - | 회수 요청 종료일(revoke_at, yyyy-MM-dd). 당일까지 포함합니다. |
reg_str_date | query | string · date | Optional | - | 발급 요청 시작일(reg_date, yyyy-MM-dd). |
reg_end_date | query | string · date | Optional | - | 발급 요청 종료일(reg_date, yyyy-MM-dd). 당일까지 포함합니다. |
Responses
발급이력 목록
application/json
JSON "code": "0001", "message": "요청 성공하였습니다.", "data": { "list": [ { "badge_id": "0QY4B3HP11FHQ", "template_id": "TPL00000000005", "title": "창의 부트캠프", "badge_type_name": "참여", "category_name": "내부훈련", "level": 2, "level_name": "중급", "recipient_name": "홍길동", "recipient_email": "test@1badge.world", "status_name": "발급완료", "email_status": "SENT", "issuing_org": "미래대학교", "valid_until": null, "issued_at": "2027-01-03 05:36:43", "reg_date": "2027-01-03 05:36:40", "revoke_at": null } ], "total_count": 1, "page": 1, "rows_per_page": 20 }
{
}
GET
/badges/history