Appearance
배지 템플릿 목록 조회
GET
/badge-templates
API 키 기관의 배지 템플릿 목록을 조회합니다. 기본 정렬은 reg_date desc, template_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). 동률은 template_id를 같은 방향으로 정렬합니다. (reg_date, title) |
order | query | string | Optional | desc | 정렬 방향(기본 desc). (asc, desc) |
template_id | query | string | Optional | - | 템플릿 ID 필터 |
title | query | string | Optional | - | 배지 제목 부분 일치 검색 |
use_yn | query | string | Optional | - | 사용 여부 필터 (Y, N) |
category_id | query | string | Optional | - | 카테고리 ID 필터 |
badge_type | query | string | Optional | - | 배지 유형 필터 (COMPLETE, COMPETENCY, ACHIEVE, PARTICIPATE, CERTIFICATE) |
category_level_id | query | string | Optional | - | 카테고리 레벨 ID 필터 |
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": [ { "template_id": "TPL00000000005", "title": "Certified Software Architect", "badge_type_name": "참여", "category_name": "내부훈련", "level": 1, "level_name": "입문", "image_url": "/api/cmmn/link/objgrp003/object003.png", "use_yn": "Y", "reg_date": "2026-01-13 10:32:30", "issued_count": 12 } ], "total_count": 3, "page": 1, "rows_per_page": 20 }
{
}
GET
/badge-templates