List all opportunities

Returns a list of opportunities.

The opportunities are returned sorted by creation date, with the most recent opportunity appearing first.

get

List all opportunities.

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Bearer {apikey}

Path parameters

agentIdstringRequired

The ID of the agent.

Query parameters

limitinteger · max: 100Optional

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

Default: 10

startingAfterstringOptional

A cursor for use in pagination. startingAfter is an opportunity ID.

endingBeforestringOptional

A cursor for use in pagination. endingBefore is an opportunity ID.

pipelineIdstringOptional

Only return opportunities for the pipeline specified by this pipeline ID.

stageIdstringOptional

Only return opportunities for the stage specified by this stage ID.

includeDeletedbooleanOptional

Whether or not to include deleted opportunities in the results.

Default: false

Responses

200

Successful Response

application/json

400

Bad Request

application/json

403

Forbidden

application/json

404

Not Found

application/json

get

/v1/agents/{agentId}/opportunities

HTTPcURLJavaScriptPython

GET /v1/agents/{agentId}/opportunities HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "hasMore": true,
  "data": [
    {
      "id": "text",
      "name": "text",
      "customerId": "text",
      "ownerId": "text",
      "score": 1,
      "amount": 1,
      "stageId": "text",
      "pipelineId": "text",
      "createdAt": "2025-12-09T20:45:11.779Z",
      "updatedAt": "2025-12-09T20:45:11.779Z",
      "removed": true
    }
  ]
}