v1

latestOpenAPI 3.1.02026-07-263788129.7 KB

Opportunities

List Opportunities

Returns a paginated list of opportunities.

post/v1/opportunities/list

Request body

pageinteger

Page number (1-indexed)

page_sizeinteger

Number of results per page

sortstring

Field to sort by. Prefix with '-' for descending order.

include_custom_fieldsboolean

Whether to include custom fields (custom_field_<uuid> keys) on each returned opportunity. Defaults to true. Set false to omit them for leaner responses; GET /v1/opportunities/{opportunity_id} always returns them.

Response

Successful Response

Example response

{
  "data": [
    {
      "id": "opp_abc123",
      "account_id": "acc_def456",
      "name": "Acme Corp - Enterprise License",
      "owner": {
        "id": "usr_abc123",
        "first_name": "Jane",
        "last_name": "Smith"
      },
      "stage": "negotiation",
      "estimated_value": {
        "currency_code": "USD",
        "amount": 5000000
      },
      "estimated_close_date": "2025-09-30",
      "actual_close_date": "2025-10-15",
      "summary": "Enterprise deal with strong champion. Procurement review in progress.",
      "risks": [
        "Budget constraints",
        "Competing vendor evaluation"
      ],
      "notes": "Follow up after Q3 board meeting",
      "tags": [
        "High Priority"
      ],
      "last_activity_at": "2025-08-20T14:30:00Z",
      "updated_at": "2025-08-21T14:30:00Z",
      "created_at": "2025-06-01T09:00:00Z"
    }
  ],
  "pagination": {
    "page": 1,
    "page_size": 25,
    "total_count": 142,
    "total_pages": 6
  }
}