Get notice list

Available in Classic and VPC

Get the list of notices.

Request

This section describes the request format. The method and URI are as follows:

Method	URI
GET	/v2/notices

Request headers

For information about the headers common to all GAMEPOT 3.0 APIs, see GAMEPOT 3.0 request headers.

Request query parameters

You can use the following query parameters with your request:

Field	Type	Required	Description
`filter`	String	Required	Filtering criteria Filter by some fields in the response body. Filter only full matches. Enter an empty value `{}` if there is no criteria. Example: `{"country":"{Country code}"}`, `{"type":"{Job type}"}`, `{"enable":true}`
`sort`	String	Optional	Sort by Enter in the form of `{Criteria:Method}`. Criteria: String type fields in the response body. Method: `-1` \| `1` `-1`: Descending `1`: Ascending e.g., `{"createdAt":"-1"}`: Descending by creation date and time.
`option`	String	Optional	Additional options: Option e.g., `{"offset":0,"per_page":20}`: Display the first 20 items.

Option

The following describes Option.

Field	Type	Required	Description
`offset`	Integer	Optional	Query start offset 0-N
`per_page`	Integer	Optional	Number of items per page 1-100

Request example

The request example is as follows:

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'

Response

This section describes the response format.

Response body

The response body includes the following data:

Field	Type	Required	Description
`totalCount`	Integer	-	Total response count
`notices`	Array	-	Notice list: notices

`notices`

The following describes notices.

Field	Type	Required	Description
`country`	String	-	Country code
`image`	Array	-	Notice image list: image
`urlArr`	Array	-	URL list: urlArr
`schemeArr`	Array	-	Scheme list: schemeArr
`_id`	String	-	Object ID
`enable`	Boolean	-	Usage `true` \| `false` `true`: Available for posting or being posted `false`: Posting unavailable
`type`	String	-	Job type `url` \| `scheme` `url`: URL redirection `scheme`: Scheme execution
`startDate`	String	-	Notice start date and time ISO 8601 format (UTC standard)
`endDate`	String	-	Notice end date and time ISO 8601 format (UTC standard)
`sort`	Integer	-	Notice sort by
`url`	String	-	URL information
`scheme`	String	-	Scheme information
`project_id`	String	-	Project ID
`store_id`	String	-	Store ID `google` \| `one` \| `apple` \| `galaxy` \| `huawei` \| `amazon` \| `nowgg` \| `pc` \| `steam` If the value is empty, apply to all stores.
`id`	String	-	Notice ID
`createdAt`	String	-	Notice creation date and time ISO 8601 format (UTC standard)
`updatedAt`	String	-	Notice modification date and time ISO 8601 format (UTC standard)
`__v`	Integer	-	Version key

Note

_id and __v are fields that can be displayed in the response results but does not affect the service use.

`image`

The following describes image.

Field	Type	Required	Description
`lang`	String	-	Language code
`value`	String	-	Resource address (below the base URL)
`default`	Boolean	-	Whether it is in default language `true` \| `false` `true`: Default language `false`: Not default language

`urlArr`

The following describes urlArr.

Field	Type	Required	Description
`lang`	String	-	Language code
`value`	String	-	URL information
`default`	Boolean	-	Whether it is in default language `true` \| `false` `true`: Default language `false`: Not default language

`schemeArr`

The following describes schemeArr.

Field	Type	Required	Description
`lang`	String	-	Language code
`value`	String	-	Scheme information
`default`	Boolean	-	Whether it is in default language `true` \| `false` `true`: Default language `false`: Not default language

Response status codes

For information about the response status codes common to all GAMEPOT 3.0 APIs, see GAMEPOT 3.0 response status codes.

Response example

The response example is as follows:

{
  "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
    }
  ]
}