Skip to main content
GET
/
v2
/
inbound
/
opportunities
List opportunities
curl --request GET \
  --url https://enrich.octolane.com/v2/inbound/opportunities \
  --header 'X-API-Key: <x-api-key>'
Simple list endpoint for Opportunities.
pipeline_id is mandatory. Filters and sorting are not supported. Use POST /opportunities/search when you need them.

Request

X-API-Key
string
required
Your Octolane API key.

Query parameters

pipeline_id
string
required
Pipeline UUID.
stage_id
string
Filter opportunities by stage.
q
string
Basic text search across opportunity name, next steps, account, and contact email.
cursor
string
Opaque cursor from a previous response.
limit
number
default:"100"
Page size. Max 500.
fields
string
Comma-separated fields or JSON-encoded string array.

Example request

curl "https://enrich.octolane.com/v2/inbound/opportunities?pipeline_id=pipeline_uuid&stage_id=stage_uuid&limit=10&q=renewal" \
  -H "X-API-Key: your-api-key"

Example response

200
{
  "success": true,
  "data": {
    "opportunities": [
      {
        "id": "opportunity_uuid",
        "name": "Enterprise Renewal",
        "pipeline_id": "pipeline_uuid",
        "stage_id": "stage_uuid",
        "stage_name": "Qualification",
        "amount": 50000,
        "probability": 40,
        "close_date": "2026-06-30T00:00:00.000Z",
        "next_action_date": null,
        "next_steps": "Follow up with buyer",
        "owner_id": "user_uuid",
        "account_id": "account_uuid",
        "account_name": "Example Inc",
        "account_domain": "example.com",
        "contact_id": "contact_uuid",
        "contact_first_name": "John",
        "contact_last_name": "Smith",
        "contact_email": "john@example.com",
        "additional_contacts": [],
        "created_at": "2026-05-25T09:30:03.285099Z",
        "updated_at": "2026-05-25T09:30:03.285099Z",
        "custom_fields": {
          "deal_source": "partner"
        }
      }
    ],
    "custom_field_definitions": {
      "deal_source": {
        "current_name": "Deal Source",
        "property_name": "select_456",
        "attribute_type": "select",
        "metadata": { "select_options": [] }
      }
    },
    "has_more": true,
    "next_cursor": "opaque_cursor",
    "limit": 10
  },
  "message": "Opportunities fetched successfully",
  "statusCode": 200
}