공지 사항 목록 조회

Classic/VPC 환경에서 이용 가능합니다.

공지 사항 목록을 조회합니다.

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

메서드	URI
GET	/v2/notices

요청 헤더

GAMEPOT 3.0 API에서 공통으로 사용하는 헤더에 대한 정보는 GAMEPOT 3.0 요청 헤더를 참조해 주십시오.

요청 쿼리 파라미터

요청 쿼리 파라미터에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`filter`	String	Required	필터링 조건 응답 바디의 일부 필드를 기준으로 필터링 전체 일치하는 값만 필터링 조건이 없는 경우, 빈 값 `{}` 입력 <예시> `{"country":"{국가코드}"}`, `{"type":"{작업유형}"}`, `{"enable":true}`
`sort`	String	Optional	정렬 기준 `{기준:방식}` 형태로 입력 기준: 응답 바디의 String 타입 필드 방식: `-1` \| `1` `-1`: 내림차순 `1`: 오름차순 <예시> `{"createdAt":"-1"}`: 생성 일시 기준 내림차순
`option`	String	Optional	추가 옵션: Option <예시> `{"offset":0,"per_page":20}`: 첫 번째 항목부터 20개 표시

Option

Option에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`offset`	Integer	Optional	조회 시작 오프셋 0~N
`per_page`	Integer	Optional	페이지당 항목 수 1~100

요청 예시

요청 예시는 다음과 같습니다.

curl --location --request GET 'https://dashboard-api.gamepot.ntruss.com/v2/notices?filter=%7B%22enable%22%3Atrue%7D&sort=%7B%22createdAt%22%3A%22-1%22%7D&option=%7B%22offset%22%3A0%2C%22per_page%22%3A20%7D' \
--header 'x-api-key: {API Key}' \
--header 'x-project-id: {Project ID}' \
--header 'Accept: application/json'

응답

응답 형식을 설명합니다.

응답 바디

응답 바디에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`totalCount`	Integer	-	전체 응답 수
`notices`	Array	-	공지 사항 목록: notices

`notices`

notices에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`country`	String	-	국가 코드
`image`	Array	-	공지 이미지 목록: image
`urlArr`	Array	-	URL 목록: urlArr
`schemeArr`	Array	-	스킴 목록: schemeArr
`_id`	String	-	객체 아이디
`enable`	Boolean	-	사용 여부 `true` \| `false` `true`: 게시 가능 또는 게시 중 `false`: 게시 불가
`type`	String	-	작업 유형 `url` \| `scheme` `url`: URL 이동 `scheme`: 스킴 실행
`startDate`	String	-	공지 시작 일시 ISO 8601 형식(UTC 기준)
`endDate`	String	-	공지 종료 일시 ISO 8601 형식(UTC 기준)
`sort`	Integer	-	공지 사항 정렬 기준
`url`	String	-	URL 정보
`scheme`	String	-	스킴 정보
`project_id`	String	-	프로젝트 아이디
`store_id`	String	-	스토어 아이디 `google` \| `one` \| `apple` \| `galaxy` \| `huawei` \| `amazon` \| `nowgg` \| `pc` \| `steam` 빈 값인 경우, 모든 스토어에 적용
`id`	String	-	공지 아이디
`createdAt`	String	-	공지 생성 일시 ISO 8601 형식(UTC 기준)
`updatedAt`	String	-	공지 수정 일시 ISO 8601 형식(UTC 기준)
`__v`	Integer	-	버전 키

참고

_id, __v는 응답 결과에 노출될 수 있으나 서비스 사용에 영향을 주지 않는 필드입니다.

`image`

image에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`lang`	String	-	언어 코드
`value`	String	-	리소스 주소(Base URL 이하)
`default`	Boolean	-	기본 언어 여부 `true` \| `false` `true`: 기본 언어 `false`: 기본 언어 아님

`urlArr`

urlArr에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`lang`	String	-	언어 코드
`value`	String	-	URL 정보
`default`	Boolean	-	기본 언어 여부 `true` \| `false` `true`: 기본 언어 `false`: 기본 언어 아님

`schemeArr`

schemeArr에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`lang`	String	-	언어 코드
`value`	String	-	스킴 정보
`default`	Boolean	-	기본 언어 여부 `true` \| `false` `true`: 기본 언어 `false`: 기본 언어 아님

응답 상태 코드

GAMEPOT 3.0 API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 GAMEPOT 3.0 응답 상태 코드를 참조해 주십시오.

응답 예시

응답 예시는 다음과 같습니다.

{
  "totalCount": 1,
  "notices": [
    {
      "country": "",
      "image": [
        {
          "lang": "ko",
          "value": "/notices/fcf67443-****-****-****-2f10a3bf9021.png",
          "default": true
        }
      ],
      "urlArr": [
        {
          "lang": "ko",
          "default": true
        }
      ],
      "schemeArr": null,
      "_id": "68cb9b7e**********4cefd5",
      "enable": true,
      "type": "url",
      "startDate": "2025-09-18T15:00:00.000Z",
      "endDate": "2025-09-19T14:59:00.000Z",
      "sort": 758174078100,
      "url": null,
      "scheme": null,
      "project_id": "fccec9bc-****-****-****-d2df78e0d987",
      "store_id": "",
      "id": "df1e517d-****-****-****-d93ee4cfd453",
      "createdAt": "2025-09-18T05:41:18.120Z",
      "updatedAt": "2025-09-22T05:25:02.723Z",
      "__v": 0
    }
  ]
}