Check and award new badges for current user

POST/v1/referral/me/check-badges

Authorization

bearerAuthbearerAuthrequired

apiKeyAuthapiKeyAuthrequired

Responses

200OK

itemsReferralAchievement[] | nullrequired

Show properties

Array of ReferralAchievement

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

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 POST "/v1/referral/me/check-badges"

const response = await fetch("/v1/referral/me/check-badges", {
  method: "POST"
});

import requests

response = requests.post(
    "/v1/referral/me/check-badges",
)

Response

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

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