Returns the caller org's deals, most recently updated first.

GET /v1/crm/opportunities

CRM → · All API references → · Six flows, four surfaces →


Address	`https://api.hanzo.ai/v1/crm/opportunities`
Method	`GET`
Operation	`get_crm_opportunities`
Auth	`Authorization: Bearer $HANZO_API_KEY`

Returns the caller org's deals, most recently updated first. A stage narrows the page to one pipeline stage.

Request

2 fields.

Field	In	Type	Required	Description
`stage`	query	string	—	Stage returns only the opportunities at that pipeline stage when set (NEW, SCREENING, MEETING, PROPOSAL or CUSTOMER; case-insensitive).
`limit`	query	integer	—	Limit caps the rows returned: 200 by default, 1000 at most.

Response

Status	Body	Meaning
`200`	oppList	ok

200 body — 11 fields.

Field	In	Type	Always	Description
`data`	body	Opportunity[]	—	Data is the page of opportunities, most recently updated first.
`data[].amount`	body	integer	—	Amount is the deal value in minor units (cents) of Currency.
`data[].closeDate`	body	integer	—	CloseDate is the expected close as a unix second (0 = unset).
`data[].companyId`	body	string	—	CompanyID links the deal to one of the org's companies; empty when unlinked, and cleared when that company is deleted.
`data[].createdAt`	body	integer	—	CreatedAt is the unix second the opportunity was created.
`data[].currency`	body	string	—	Currency is the ISO code Amount is denominated in; a write that names none stores USD.
`data[].id`	body	string	—	ID is the server-minted opportunity id ("oppo_" + 128 random bits).
`data[].name`	body	string	—	Name is the deal name.
`data[].pointOfContactId`	body	string	—	PointOfContact links the deal to one of the org's contacts; empty when unlinked, and cleared when that contact is deleted.
`data[].stage`	body	string	—	Stage is the pipeline stage, always one of NEW, SCREENING, MEETING, PROPOSAL or CUSTOMER — stored upper-case whatever case the write used.
`data[].updatedAt`	body	integer	—	UpdatedAt is the unix second of the last write.

Failure carries the platform error shape — see Errors.

Examples

hanzo crm opportunities list

import { Configuration, CrmApi } from 'hanzoai';

const api = new CrmApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getCrmOpportunities();

from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import CrmApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = CrmApi(client).get_crm_opportunities()

cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)

resp, _, err := client.CrmAPI.GetCrmOpportunities(context.Background()).Execute()
if err != nil {
	return err
}

use hanzo_cloud::apis::{configuration::Configuration, crm_api};

let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();

let result = crm_api::get_crm_opportunities(&cfg, Default::default()).await?;

import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.CrmApi;

ApiClient client = new ApiClient();
client.setRequestInterceptor(b -> b.header("Authorization", "Bearer " + System.getenv("HANZO_API_KEY")));

var result = new CrmApi(client).getCrmOpportunities();

curl https://api.hanzo.ai/v1/crm/opportunities \
  -H "Authorization: Bearer $HANZO_API_KEY"

The door reaches crm through the crm tool, which names its 20 operations with its own verbs — this one among them, under a name only the door declares. describe explains any of them:

curl -X POST https://api.hanzo.ai/v1/mcp \
  -H "Content-Type: application/json" \
  -d '{
       "jsonrpc": "2.0",
       "id": 1,
       "method": "tools/call",
       "params": {
         "name": "describe",
         "arguments": {
           "op": "list_crm_applications"
         }
       }
     }'

CRM API · All Hanzo APIs · Interactive reference

Returns the caller org's deals, most recently updated first.

Request

Response

Examples

On this page