---
title: "opportunities"
description: "REST API endpoints for opportunities."
canonical_url: "https://www.zeyos.com/api/opportunities"
markdown_url: "https://www.zeyos.com/ai/guide/api/opportunities.md"
section: "api-reference"
authority: "reference"
language: "en"
source_repository: "https://cloud.zeyos.com/__doc/openapi/api.json"
source_sha256: "f5850c6fa6f99a1b518fc8ddc4e566070b53b5506cde57a3299948d38fc6363c"
---

# ZeyOS Standard REST API (v1)

## Tag: opportunities
Opportunities

## Spec
- /__doc/openapi/api.json

## Servers
- https://cloud.zeyos.com/{INSTANCE}/api/v1 — ZeyOS Cloud

## Authentication
- oauth (oauth2) — OAuth 2.0 Authorization ([RFC 6749](https://tools.ietf.org/html/rfc6749)); use the **[ZeyOS OAuth 2.0 API](https://developers.zeyos.com/oauth2) `POST /oauth2/v1/token`** to obtain a valid bearer token
- token (http) — HTTP Bearer Authentication ([RFC 6750](https://tools.ietf.org/html/rfc6750))
- session (apiKey) — Session Cookie Authentication ([RFC 6265](https://tools.ietf.org/html/rfc6265))

## Endpoints
| Method | Path | Summary |
| ------ | ---- | ------- |
| POST | /opportunities | List opportunities |
| PUT | /opportunities | Create new opportunity |
| DELETE | /opportunities/{ID} | Delete opportunity |
| GET | /opportunities/{ID} | Get opportunity |
| HEAD | /opportunities/{ID} | Check if opportunity exists |
| PATCH | /opportunities/{ID} | Update existing opportunity |

### POST /opportunities
- Summary: List opportunities
- OperationId: listOpportunities
- Description: List selected data from all opportunities that match the specified filter and search criteria in a specific sort order. Requires `opportunities` permission.

Parameters:
- (none)

Request body:
- #/components/requestBodies/list

Responses:
- 200 — OK
  - application/json — array
- 401: #/components/responses/401
- 403: #/components/responses/403
- 500: #/components/responses/500

### PUT /opportunities
- Summary: Create new opportunity
- OperationId: createOpportunity
- Description: Create a new opportunity and return its persistent data. Requires writable `opportunities` permission.

Parameters:
- (none)

Request body:
- #/components/requestBodies/opportunities

Responses:
- 201 — Successful Creation (Created)
  - application/json — #/components/schemas/opportunities
- 401: #/components/responses/401
- 403: #/components/responses/403
- 409 — ID Present (Conflict)
- 410 — Gone
- 500: #/components/responses/500

### DELETE /opportunities/{ID}
- Summary: Delete opportunity
- OperationId: deleteOpportunity
- Description: Permanently delete an existing opportunity by **`ID`**. Requires writable `opportunities` permission.

Parameters:
- #/components/parameters/ID
- #/components/parameters/If-Match
- #/components/parameters/If-Unmodified-Since

Request body:
- (none)

Responses:
- 204 — Successful Deletion (No Content)
- 401: #/components/responses/401
- 403: #/components/responses/403
- 404 — Not Found
- 409 — Not Deletable (Conflict)
- 412 — Non-matching ETag (Precondition Failed)
- 500: #/components/responses/500

### GET /opportunities/{ID}
- Summary: Get opportunity
- OperationId: getOpportunity
- Description: Return the data of an existing opportunity by **`ID`**. Requires `opportunities` permission.

Parameters:
- #/components/parameters/ID
- #/components/parameters/expand
- #/components/parameters/extdata
- #/components/parameters/tags
- #/components/parameters/If-Modified-Since
- #/components/parameters/If-None-Match

Request body:
- (none)

Responses:
- 200 — OK
  - application/json — #/components/schemas/opportunities
- 304 — Not Modified
- 401: #/components/responses/401
- 403: #/components/responses/403
- 404 — Not Found
- 500: #/components/responses/500

### HEAD /opportunities/{ID}
- Summary: Check if opportunity exists
- OperationId: existsOpportunity
- Description: Check if an opportunity with **`ID`** exists, but do not return its data. Requires `opportunities` permission.

Parameters:
- #/components/parameters/ID
- #/components/parameters/If-Modified-Since
- #/components/parameters/If-None-Match

Request body:
- (none)

Responses:
- 204: #/components/responses/204-exists
- 304 — Not Modified
- 401: #/components/responses/401
- 404 — Not Found
- 500: #/components/responses/500

### PATCH /opportunities/{ID}
- Summary: Update existing opportunity
- OperationId: updateOpportunity
- Description: Update an existing opportunity by **`ID`** and return its persistent data. Requires writable `opportunities` permission.

Parameters:
- #/components/parameters/ID
- #/components/parameters/If-Match
- #/components/parameters/If-Unmodified-Since

Request body:
- #/components/requestBodies/opportunities

Responses:
- 200 — Successful Update (OK)
  - application/json — #/components/schemas/opportunities
- 401: #/components/responses/401
- 403: #/components/responses/403
- 404 — Not Found
- 409 — Non-matching ID (Conflict)
- 410 — Gone
- 412 — Non-matching ETag (Precondition Failed)
- 500: #/components/responses/500