# API

By understanding the claimr API and utilizing your API token correctly, you can integrate claimr's functionalities into your system and unlock new possibilities for data analysis.\
\
**What can you do with the ⚡️claimr API?**

* **Retrieve user information:** Access data about users who have interacted with your claimr campaigns, such as their progress, rewards earned, and participation history.
* **Check balances:** Retrieve information about user point balances tracked within your campaigns, including total points (sum of all points), referral points, and user-generated content (UGC) points.
* **Monitor user activity:** Track user actions and engagement within your claimr campaigns, providing valuable insights into user behavior and campaign performance.
* **Subscribe to webhooks:** Receive real-time updates on events happening within your campaigns, such as task completions, reward claims, or new user registrations. This allows your system to react dynamically to user actions and provide a more personalized experience.

<br>

<table data-view="cards"><thead><tr><th align="center"></th><th data-hidden data-card-target data-type="content-ref"></th><th data-hidden data-card-cover data-type="files"></th></tr></thead><tbody><tr><td align="center"><strong>API token</strong> </td><td><a href="/pages/d5tMwX8azKuDUzcPv7Eb">/pages/d5tMwX8azKuDUzcPv7Eb</a></td><td><a href="/files/LDB9kl4qiuFFwKjGuOof">/files/LDB9kl4qiuFFwKjGuOof</a></td></tr><tr><td align="center"><strong>API methods</strong> </td><td><a href="/pages/RajWzh2xUVDUCzle664W">/pages/RajWzh2xUVDUCzle664W</a></td><td><a href="/files/ytE2rki8Pfew9suqA1hs">/files/ytE2rki8Pfew9suqA1hs</a></td></tr><tr><td align="center"><strong>User token</strong></td><td><a href="/pages/5X4COmWokH0CGUjNJHZh">/pages/5X4COmWokH0CGUjNJHZh</a></td><td><a href="/files/brfxm4AP4ACE6jiaQMSV">/files/brfxm4AP4ACE6jiaQMSV</a></td></tr></tbody></table>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://claimr-io.gitbook.io/claimr-help-center/api.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
