Get support notice list

Prev Next

Available in Classic and VPC

Get the notice list in the Support page.

Request

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

Method URI
GET /v2/stories/{boardId}

Request headers

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

Request path parameters

You can use the following path parameters with your request:

Field Type Required Description
boardId String Required Board ID
  • cs_notice (valid value)

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: {"author_id":"{Creator ID}"}, {"id":"{Notice ID}"}, {"required":false}
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/stories/cs_notice?filter=%7B%22required%22%3Afalse%7D&sort=%7B%22createdAt%22%3A%20%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
stories Array - Notice list: stories

stories

The following describes stories.

Field Type Required Description
required Boolean - Whether it is required
  • true | false
    • true: Required
    • false: Not required
hit Integer - Number of views
_id String - Object ID
title Array - Notice title: title
category_id String - Board ID
status Integer - Notice usage
  • 1 | 0
    • 1: Enabled
    • 0: Disabled
text Array - Notice content: text
project_id String - Project ID
author_id String - Creator ID
id String - Notice ID
createdAt String - Notice creation date and time
  • ISO 8601 format
updatedAt String - Notice modification date and time
  • ISO 8601 format
__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.

title

The following describes title.

Field Type Required Description
lang String - Language code
value String - Notice title
default Boolean - Whether it is in default language
  • true | false
    • true: Default language
    • false: Not default language

text

The following describes text.

Field Type Required Description
lang String - Language code
value String - Notice content
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": 2,
  "stories": [
    {
      "required": false,
      "hit": 0,
      "_id": "68d5d78991f09a68dbbf908a",
      "title": [
        {
          "lang": "ko",
          "value": "[Test notice] Support page notice feature verification",
          "default": true
        }
      ],
      "category_id": "cs_notice",
      "status": 1,
      "text": [
        {
          "lang": "ko",
          "value": "<p data-start=\"141\" data-end=\"239\"><span style=\"color: rgb(185, 106, 217);\">This post is registered for <strong data-start=\"146\" data-end=\"159\">internal QA testing</strong>.</span><br data-start=\"175\" data-end=\"178\"><span style=\"color: rgb(185, 106, 217);\">This is unrelated to actual service notice and is intended solely to verify that the notice registration, viewing, and deletion features are operating correctly.</span></p>\n<p data-start=\"241\" data-end=\"249\"><span style=\"color: rgb(185, 106, 217);\">Thank you.</span></p>",
          "default": true
        }
      ],
      "project_id": "fccec9bc-****-****-****-d2df78e0d987",
      "author_id": "b2dfa23b-****-****-****-0f392a4175fb",
      "id": "a5500dbf-****-****-****-eb2329918aa5",
      "createdAt": "2025-09-26T00:00:09.954Z",
      "updatedAt": "2025-09-26T00:00:09.954Z",
      "__v": 0
    },
    {
      "required": false,
      "hit": 0,
      "_id": "68d096fdc9abf71dd89dacac",
      "title": [
        {
          "lang": "ko",
          "value": "Announcement",
          "default": true
        },
        {
          "lang": "en",
          "value": "Announcement",
          "default": false
        }
      ],
      "category_id": "cs_notice",
      "status": 1,
      "text": [
        {
          "lang": "ko",
          "value": "<p>Dear users,</p>\n<p>&nbsp;</p>\n<p>Hi. This is the announcement.</p>\n<p>&nbsp;</p>\n<p>Thank you.</p>",
          "default": true
        },
        {
          "lang": "en",
          "value": "<p>Dear User,</p>\n<p>&nbsp;</p>\n<p>Hello. This article is about the announcement.</p>\n<p>&nbsp;</p>\n<p>Thank you.</p>",
          "default": false
        }
      ],
      "project_id": "fccec9bc-****-****-****-d2df78e0d987",
      "author_id": "b2dfa23b-****-****-****-0f392a4175fb",
      "id": "e5d72544-****-****-****-b9cbbfd0859b",
      "createdAt": "2025-09-22T00:23:25.230Z",
      "updatedAt": "2025-09-26T00:05:32.708Z",
      "__v": 0
    }
  ]
}