Achievement

Web API References for Achievement Service

Explore the list of Web APIs functions available for managing achievement, including detailed descriptions and usage examples.

To use service functions, first ensure that the service is activated before. You can see services by opening "Service Hub" From the game's dashboard header.

Retrieves achievement data by its unique identifier.

get

Path parameters

achievementIdinteger · int32Required

Responses

200

OK

text/plainapplication/jsontext/json

get

HTTPcURLJavaScriptPython

GET /api/table/services/achievements/{achievementId} HTTP/1.1
Host: 
Accept: */*

200

OK

{
  "list": [
    {
      "id": 1,
      "name": "text",
      "desc": "text",
      "image": "text",
      "extend_table": "text",
      "step_extend_table": "text",
      "start_at": "2025-07-03T11:23:31.135Z",
      "end_at": "2025-07-03T11:23:31.135Z",
      "steps": []
    }
  ],
  "totalCount": 1
}

Retrieves a list of achievements for the current user based on the provided parameters.

get

Query parameters

justDonebooleanOptionalDefault: true

skipinteger · int32OptionalDefault: 0

limitinteger · int32OptionalDefault: 25

Responses

200

OK

text/plainapplication/jsontext/json

get

HTTPcURLJavaScriptPython

GET /api/table/services/achievements HTTP/1.1
Host: 
Accept: */*

200

OK

{
  "list": [
    {
      "id": 1,
      "name": "text",
      "desc": "text",
      "image": "text",
      "extend_table": "text",
      "step_extend_table": "text",
      "start_at": "2025-07-03T11:23:31.135Z",
      "end_at": "2025-07-03T11:23:31.135Z",
      "steps": []
    }
  ],
  "totalCount": 1
}

Unlocks an achievement for the current user based on the provided parameters.

post

Body

application/jsontext/jsonapplication/*+json

achievement_idinteger · int32Required

step_idinteger · int32Required

Responses

200

OK

text/plainapplication/jsontext/json

post

HTTPcURLJavaScriptPython

POST /api/table/services/achievements HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 32

{
  "achievement_id": 1,
  "step_id": 1
}

application/jsontext/jsonapplication/*+json

200

OK

{
  "row": {
    "id": 1,
    "player": 1,
    "achievement": 1,
    "step": 1
  }
}