Retrieve an opportunity

Retrieve an opportunity object. If it’s for a deleted object, the removed property is set to true.

get

Retrieve an opportunity

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Bearer {apikey}

Path parameters

agentIdstringRequired

The ID of the agent.

opportunityIdstringRequired

The ID of the opportunity.

Responses

200

Successful Response

application/json

This an object representing a sales opportunity.

idstringOptional

The ID of the opportunity.

namestringOptional

The name of the opportunity.

customerIdstringOptional

The ID of the customer the opportunity belongs to.

ownerIdstring · nullableOptional

The ID of the owner of the opportunity.

scorenumber · nullableOptional

The score of the opportunity.

amountnumber · nullableOptional

The amount of the opportunity.

stageIdstringOptional

The ID of the stage the opportunity belongs to.

pipelineIdstringOptional

The ID of the pipeline the opportunity belongs to.

createdAtstring · date-timeOptional

The date and time the opportunity was created in ISO 8601 format.

updatedAtstring · date-timeOptional

The date and time the opportunity was last updated in ISO 8601 format.

removedbooleanOptional

Whether the opportunity has been removed.

tagsstring[]Optional

The tags associated with the opportunity.

400

Bad Request

application/json

403

Forbidden

application/json

404

Not Found

application/json

get

/v1/agents/{agentId}/opportunities/{opportunityId}

HTTPcURLJavaScriptPython

GET /v1/agents/{agentId}/opportunities/{opportunityId} HTTP/1.1
Host: api.voxity.ai
Authorization: YOUR_API_KEY
Accept: */*

{
  "id": "text",
  "name": "text",
  "customerId": "text",
  "ownerId": "text",
  "score": 1,
  "amount": 1,
  "stageId": "text",
  "pipelineId": "text",
  "createdAt": "2026-04-02T08:51:52.622Z",
  "updatedAt": "2026-04-02T08:51:52.622Z",
  "removed": true,
  "tags": [
    "text"
  ],
  "metadata": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}