Achievements

Operations related to achievement management

Get achievements

get

https://api.example.com/v1https://staging-api.example.com/v1

/achievement

Retrieve achievements with optional filtering and pagination

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

pageNumberinteger · min: 1Optional

Page number for pagination

Default: 1

pageSizeinteger · min: 1 · max: 100Optional

Number of items per page

Default: 10

achievementTitlestringOptional

Filter by achievement title

levelstringOptional

Filter by achievement level

statusstringOptional

Filter by achievement status

Responses

200

Achievements retrieved successfully

application/json

500

Internal server error

application/json

get

/achievement

HTTPcURLJavaScriptPython

GET /v1/achievement HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "success": true,
  "pagination": {
    "currentPage": 1,
    "totalPages": 1,
    "totalItems": 1,
    "itemsPerPage": 1,
    "hasNextPage": true,
    "hasPreviousPage": true
  },
  "data": [
    {
      "achievementId": "123e4567-e89b-12d3-a456-426614174000",
      "achievementTitle": "text",
      "achievementDescription": "text",
      "thresholdScore": "text",
      "level": "text",
      "textColor": "text",
      "backgroundColor": "text",
      "status": "text",
      "createdAt": "2025-12-17T07:39:00.889Z",
      "updatedAt": "2025-12-17T07:39:00.889Z",
      "createdBy": "123e4567-e89b-12d3-a456-426614174000",
      "updatedBy": "123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}

Create new achievement

post

https://api.example.com/v1https://staging-api.example.com/v1

/achievement/create

Create a new achievement with required fields

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

achievementTitlestring · max: 100Required

Title of the achievement

achievementDescriptionstring · max: 255Required

Description of the achievement

thresholdScorestringRequired

Minimum score required for the achievement

levelstringRequired

Level of the achievement

textColorstring · max: 20Required

Text color for the achievement display

backgroundColorstring · max: 20Required

Background color for the achievement display

statusstring · max: 20Optional

Status of the achievement

createdAtstring · date-timeOptional

Creation timestamp

updatedAtstring · date-timeOptional

Update timestamp

Responses

201

Achievement created successfully

application/json

400

Validation error

application/json

500

Internal server error

application/json

post

/achievement/create

HTTPcURLJavaScriptPython

POST /v1/achievement/create HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 236

{
  "achievementTitle": "text",
  "achievementDescription": "text",
  "thresholdScore": "text",
  "level": "text",
  "textColor": "text",
  "backgroundColor": "text",
  "status": "text",
  "createdAt": "2025-12-17T07:39:00.889Z",
  "updatedAt": "2025-12-17T07:39:00.889Z"
}

{
  "success": true,
  "message": "Achievement created successfully",
  "data": {
    "achievementId": "123e4567-e89b-12d3-a456-426614174000",
    "achievementTitle": "text",
    "achievementDescription": "text",
    "thresholdScore": "text",
    "level": "text",
    "textColor": "text",
    "backgroundColor": "text",
    "status": "text",
    "createdAt": "2025-12-17T07:39:00.889Z",
    "updatedAt": "2025-12-17T07:39:00.889Z",
    "createdBy": "123e4567-e89b-12d3-a456-426614174000",
    "updatedBy": "123e4567-e89b-12d3-a456-426614174000"
  }
}

Update achievement

put

https://api.example.com/v1https://staging-api.example.com/v1

/achievement/update/{achievementId}

Update an existing achievement by ID

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

achievementIdstring · uuidRequired

The ID of the achievement to update

Body

application/json

achievementTitlestring · max: 100Optional

Title of the achievement

achievementDescriptionstring · max: 255Optional

Description of the achievement

thresholdScorestringOptional

Minimum score required for the achievement

levelstringOptional

Level of the achievement

textColorstring · max: 20Optional

Text color for the achievement display

backgroundColorstring · max: 20Optional

Background color for the achievement display

statusstring · max: 20Optional

Status of the achievement

createdAtstring · date-timeOptional

Creation timestamp

updatedAtstring · date-timeOptional

Update timestamp

Responses

200

Achievement updated successfully

application/json

400

Validation error

application/json

500

Internal server error

application/json

put

/achievement/update/{achievementId}

HTTPcURLJavaScriptPython

PUT /v1/achievement/update/{achievementId} HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 236

{
  "achievementTitle": "text",
  "achievementDescription": "text",
  "thresholdScore": "text",
  "level": "text",
  "textColor": "text",
  "backgroundColor": "text",
  "status": "text",
  "createdAt": "2025-12-17T07:39:00.889Z",
  "updatedAt": "2025-12-17T07:39:00.889Z"
}

{
  "success": true,
  "message": "Achievement updated successfully"
}