Get current user achievements with badge definitions

GET/v1/referral/me/achievements

Authorization

bearerAuthbearerAuthrequired

apiKeyAuthapiKeyAuthrequired

Responses

200OK

itemsUserAchievementView[] | nullrequired

Show properties

Array of UserAchievementView

achievementReferralAchievement

Show properties

badge_levelinteger<int32>required

badge_typestringrequired

created_atstring<date-time>required

earned_atstring<date-time>required

idstringrequired

metadatastringrequired

organization_idstringrequired

updated_atstring<date-time>required

user_idstringrequired

definitionBadgeDefinitionrequired

Show properties

descriptionstringrequired

iconstringrequired

max_levelinteger<int64>required

namestringrequired

requirementinteger<int64>required

typestringrequired

earnedbooleanrequired

401Unauthorized

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

403Forbidden

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

500Internal Server Error

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

Request

curl -X GET "/v1/referral/me/achievements"

const response = await fetch("/v1/referral/me/achievements", {
  method: "GET"
});

import requests

response = requests.get(
    "/v1/referral/me/achievements",
)

Response

{
  "items": [
    {
      "achievement": {
        "badge_level": 0,
        "badge_type": "string",
        "created_at": "2024-01-01T00:00:00Z",
        "earned_at": "2024-01-01T00:00:00Z",
        "id": "string",
        "metadata": "string",
        "organization_id": "string",
        "updated_at": "2024-01-01T00:00:00Z",
        "user_id": "string"
      },
      "definition": {
        "description": "string",
        "icon": "string",
        "max_level": 0,
        "name": "string",
        "requirement": 0,
        "type": "string"
      },
      "earned": true
    }
  ]
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}