> For the complete documentation index, see [llms.txt](https://docs.vomevolunteer.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.vomevolunteer.com/resources/editor-5.md).

# Opportunities

This object represents an opportunity within your organization. An opportunity belongs to a category, and each category can have one or more opportunities attached to it (for example, a "Community Outreach" category may contain roles like "Weekend Mentor" and "Event Support").

If you're not familiar with Vome's system, the hierarchy works as follows: `Category > Opportunity`

Each opportunity stores the key details used to describe it, including its title, description, related category, and, when published, a public share URL.

You can use the Opportunities API to list all opportunities for your institution, retrieve a single opportunity by ID, or search opportunities using filters such as title, description, category, status, and created date.

**Endpoints**\
`GET /api/opportunities/`\
`GET /api/opportunities/{opportunity_role_id}/`\
`GET /api/opportunities/search/`


---

# 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 dynamically by asking a question.

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

```
GET https://docs.vomevolunteer.com/resources/editor-5.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.