Skip to main content
GET
/
opportunities
/
search
Search Opportunity
curl --request GET \
  --url https://services.leadconnectorhq.com/opportunities/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Version: <version>'
{
  "opportunities": [
    {
      "id": "yWQobCRIhRguQtD2llvk",
      "name": "testing",
      "monetaryValue": 500,
      "pipelineId": "VDm7RPYC2GLUvdpKmBfC",
      "pipelineStageId": "e93ba61a-53b3-45e7-985a-c7732dbcdb69",
      "assignedTo": "zT46WSCPbudrq4zhWMk6",
      "status": "open",
      "source": "",
      "lastStatusChangeAt": "2021-08-03T04:55:17.355Z",
      "lastStageChangeAt": "2021-08-03T04:55:17.355Z",
      "lastActionDate": "2021-08-03T04:55:17.355Z",
      "indexVersion": 1,
      "createdAt": "2021-08-03T04:55:17.355Z",
      "updatedAt": "2021-08-03T04:55:17.355Z",
      "contactId": "zT46WSCPbudrq4zhWMk6",
      "locationId": "zT46WSCPbudrq4zhW",
      "contact": {
        "id": "byMEV0NQinDhq8ZfiOi2",
        "name": "John Deo",
        "companyName": "Tesla Inc",
        "email": "john@deo.com",
        "phone": "+1202-555-0107",
        "tags": [
          "<string>"
        ]
      },
      "notes": [
        "<array>"
      ],
      "tasks": [
        "<array>"
      ],
      "calendarEvents": [
        "<array>"
      ],
      "lostReasonId": "zT46WSCPbudrq4zhWMk6",
      "customFields": [
        {
          "id": "MgobCB14YMVKuE4Ka8p1",
          "fieldValue": "<string>"
        }
      ],
      "followers": [
        "<array>"
      ]
    }
  ],
  "meta": {
    "total": 1,
    "nextPageUrl": "http://localhost:5066/opportunities/search?q=&location_id=ve9EPM428h8vShlRW1KT&pipeline_id=&pipeline_stage_id=&status=&assigned_to+=&campaignId=&id=&order=&endDate=&startAfter=1625203104328&startAfterId=yWQobCRIhRguQtD2llvk&date=&limit=1&country=&page=1",
    "startAfterId": "yWQobCRIhRguQtD2llvk",
    "startAfter": 1625203104328,
    "currentPage": 2,
    "nextPage": 3,
    "prevPage": 1
  },
  "aggregations": {}
}

Authorizations

Authorization
string
header
required

Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.

Headers

Version
enum<string>
required

API Version

Available options:
2021-07-28

Query Parameters

q
string
Example:

"john@deo.com"

location_id
string
required

Location Id

Example:

"i2SpAtBVHSVea1sL6oah"

pipeline_id
string

Pipeline Id

Example:

"bCkKGpDsyPP4peuKowkG"

pipeline_stage_id
string

stage Id

Example:

"7915dedc-8f18-44d5-8bc3-77c04e994a10"

contact_id
string

Contact Id

Example:

"WFwVrSSjZ2CNHbZThQX2"

status
enum<string>
Available options:
open,
won,
lost,
abandoned,
all
assigned_to
string
Example:

"082goXVW3lIExEQPOnd3"

campaignId
string

Campaign Id

Example:

"Y2I9XM7aO1hncuSOlc9L"

id
string

Opportunity Id

Example:

"123akv4LFn6C9frZoy3e"

order
string
Example:

"added_asc"

endDate
string

End date

Example:

"mm-dd-yyyy"

startAfter
string

Start After

Example:

"1628008053263"

startAfterId
string

Start After Id

Example:

"UIaE1WjAwWKdlyD7osQI"

date
string

Start date

Example:

"mm-dd-yyyy"

country
string
Example:

"US"

page
number
default:1
limit
number
default:20

Limit Per Page records count. will allow maximum up to 100 and default will be 20

getTasks
boolean

get Tasks in contact

Example:

false

getNotes
boolean

get Notes in contact

Example:

false

getCalendarEvents
boolean

get Calender event in contact

Example:

false

Response

Successful response

opportunities
object[]
meta
object
aggregations
object
Last modified on March 4, 2026