> 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/the-opportunity-object.md).

# The Opportunity Object

```json
{
  "id": "2f56f3ef-08f5-4e5a-bf5b-76ca8fc4d5f1",
  "created_at": "2026-02-05T07:40:29.324645Z",
  "category": {
    "id": "d610ab31-e480-4ef1-9e35-94f94ebacde9",
    "title": "Community Outreach",
    "description": "Programs and roles related to outreach work."
  },
  "title": "Weekend Mentor",
  "description": "Support volunteers during weekend sessions.",
    "share_opportunity_url": "https://api.vomevolunteer.com/api/share/opportunity/73bb56fa-6c7f-4fce-ad5a-32eb1ba215a6"
}
```

**Response Object**:

* `id` The unique UUID of the opportunity role.
* `category` The parent category or opportunity this role belongs to.
* `category.id` The unique UUID of the related category.
* `category.title` The name of the related category.
* `category.description` A short description of the related category.
* `title` The title or name of the opportunity.
* `description` A short description of the opportunity role and what it involves.
* `share_opportunity_url` A public-facing share link for the opportunity. This is only returned when the role is published. If the role is not published, this value may be `null`.


---

# 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, and the optional `goal` query parameter:

```
GET https://docs.vomevolunteer.com/resources/editor-5/the-opportunity-object.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.