Search Opportunity
GET https://services.leadconnectorhq.com/opportunities/search
Authorization
Query parameters
Responses
200 - Successful response
opportunities (object[])
id (string): Example: yWQobCRIhRguQtD2llvk
name (string): Example: testing
monetaryValue (number): Example: 500
pipelineId (string): Example: VDm7RPYC2GLUvdpKmBfC
pipelineStageId (string): Example: e93ba61a-53b3-45e7-985a-c7732dbcdb69
assignedTo (string): Example: zT46WSCPbudrq4zhWMk6
status (string): Example: open
lastStatusChangeAt (string): Example: 2021-08-03T04:55:17.355Z
lastStageChangeAt (string): Example: 2021-08-03T04:55:17.355Z
lastActionDate (string): Example: 2021-08-03T04:55:17.355Z
indexVersion (string): Example: 1
createdAt (string): Example: 2021-08-03T04:55:17.355Z
updatedAt (string): Example: 2021-08-03T04:55:17.355Z
contactId (string): Example: zT46WSCPbudrq4zhWMk6
locationId (string): Example: zT46WSCPbudrq4zhW
contact (object)
id (string): Example: byMEV0NQinDhq8ZfiOi2
name (string): Example: John Deo
companyName (string): Example: Tesla Inc
email (string): Example: john@deo.com
phone (string): Example: +1202-555-0107
lostReasonId (string): Example: zT46WSCPbudrq4zhWMk6
customFields (object[])
id (string, required): Example: MgobCB14YMVKuE4Ka8p1
fieldValue (object, required): The value of the custom field
externalObjectId (string)
meta (object)
total (number): Example: 1
nextPageUrl (string): Example: 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 (string): Example: yWQobCRIhRguQtD2llvk
startAfter (number): Example: 1625203104328
currentPage (number): Example: 2
nextPage (number): Example: 3
prevPage (number): Example: 1
{
"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": []
},
"notes": [
[]
],
"tasks": [
[]
],
"calendarEvents": [
[]
],
"lostReasonId": "zT46WSCPbudrq4zhWMk6",
"customFields": [
{}
// truncado: 18 lineas mas
}
400 - Bad Request
401 - Unauthorized
422 - Unprocessable Entity
Example
curl -X GET 'https://services.leadconnectorhq.com/opportunities/search' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28'
const response = await fetch('https://services.leadconnectorhq.com/opportunities/search', {
method: 'GET',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
},
});
const data = await response.json();
import os, requests
response = requests.request(
'GET',
'https://services.leadconnectorhq.com/opportunities/search',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
},
)
data = response.json()
<?php
$ch = curl_init('https://services.leadconnectorhq.com/opportunities/search');
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
],
]);
$data = json_decode(curl_exec($ch), true);