GET/api/v1/opportunities

Get all Opportunities

Returns a list of opportunities with pagination support.

Authentication

Send your API key in the x-api-key header.

x-api-keybearer

Parameters

page

query · number

Page number to retrieve.

limit

query · number

Number of items per page.

name

query · string

Opportunity name to filter opportunities by (partial match).

contactId

query · string

Contact ID to filter opportunities by contact relationship.

Responses

200

PublicApiGetOpportunitiesResponseDto

statusCoderequired

number

countrequired

number

errorrequired

string

datarequired

array<PublicApiOpportunityDto>

Example response

json

{
  "statusCode": 200,
  "count": 0,
  "error": null,
  "data": [
    {
      "id": "5516cd47-2bd0-4f4f-adc2-22524e54ba4d",
      "name": "Enterprise Software License",
      "amount": 50000,
      "finalAmount": 45000,
      "risk": "Low",
      "priority": "High",
      "description": "Enterprise software license for 500 users",
      "featuredNotes": "Key decision maker is the CTO",
      "nextStep": "FollowUp",
      "closeDate": "2024-03-10T00:00:00.000Z",
      "closeProbability": 75,
      "status": "open",
      "createdAt": "2024-01-15T10:00:00.000Z",
      "updatedAt": "2024-01-15T10:00:00.000Z"
    }
  ]
}

401Unauthorized - missing or invalid API key or Bearer token