> For the complete documentation index, see [llms.txt](https://docs.perkville.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.perkville.com/integrations/integrating-perkville/integrating-your-app-with-perkville/challenges-page.md).

# Challenges page

You can create a page within your mobile app to display the list of challenges available to customers.

#### Accessing Challenges

To retrieve the list of challenges, you can use the [**Challenges View** endpoint](https://www.perkville.com/developers/docs/v2/#v2_rewards_program_challenges_view_anchor). This endpoint curates the challenges that the current customer is meant to see, replicating the below view. To achieve this, this endpoint provides the following filtering options in addition to others:

1. **User Filters**: Use these filters to obtain all challenges from the perspective a specific customer. This allows you to display only the challenges relevant to the logged-in customer, as some challenges may be suppressed from their view. If not provided, the endpoint will return challenges from the perspective of a logged out customer.
2. **Joined Challenge Filter**: This filter retrieves all challenges that the customer has joined to replicate the My Challenges tab.

Please note the following:

* **Joining Challenges**: The [**Challenge Connection** endpoint](https://www.perkville.com/developers/docs/v2/#v2_resource_4_anchor) can be utilized to allow customers to join a challenge. If the customer is eligible to join (indicated by values retrieved from the **Challenges View** endpoint), you can implement a join button next to each joinable challenge, enabling customers to participate easily.

<figure><img src="https://2181708597-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FSiE75SeColbiBVbet0NZ%2Fuploads%2FUENFiV1ibPM6Xovn6S1K%2Fchallenge_list_perkville_page_join_example.png?alt=media&amp;token=44b9ef8b-b8b1-4e63-9668-a78ab781714e" alt="" width="370"><figcaption></figcaption></figure>

You may want to change the status after the customer joins the challenge.

<figure><img src="https://2181708597-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FSiE75SeColbiBVbet0NZ%2Fuploads%2FdyxEUYt65RZ88JqP2XCz%2Fchallenge_list_Perkville_page_in_progress_example.png?alt=media&amp;token=3dc382cf-149b-4632-99ce-2cf978c4b9f0" alt="" width="370"><figcaption></figcaption></figure>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

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

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.perkville.com/integrations/integrating-perkville/integrating-your-app-with-perkville/challenges-page.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
