The caller's awards earned from one document

GET

/api/v1/documents/{documentId}/achievements

const url = 'https://api.yggy.tech/api/v1/documents/example/achievements';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.yggy.tech/api/v1/documents/example/achievements \
  --header 'Authorization: Bearer <token>'

Authorizations

bearerAuth
apiKeyAuth

Parameters

Path Parameters

documentId

required

string

>= 1 characters

Header Parameters

host

string | null

x-yggy-organization-id

string | null

Responses

200

Awards from the document

application/json

object

awards

required

Array<object>

object

required

string

rarity

required

string

Allowed values: common rare epic legendary exotic

earnedAt

required

string

sourceDocumentId

required

string | null

Example

{
  "awards": [
    {
      "rarity": "common"
    }
  ]
}

404

Document not found or achievements are not enabled