Search Opportunity - Leadway API

Search Opportunity

GET https://services.leadconnectorhq.com/opportunities/search

Autorización

string

required

Bearer token generado desde el portal Leadway. Ver Autenticación.

string

default:"2021-07-28"

required

Versión de la API.

Query parameters

string

default:"john@deo.com"

string

default:"i2SpAtBVHSVea1sL6oah"

required

Account Id

string

default:"bCkKGpDsyPP4peuKowkG"

Pipeline Id

string

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

stage Id

string

default:"WFwVrSSjZ2CNHbZThQX2"

Contact Id

string

string

default:"082goXVW3lIExEQPOnd3"

string

default:"Y2I9XM7aO1hncuSOlc9L"

Campaign Id

string

default:"123akv4LFn6C9frZoy3e"

Opportunity Id

string

default:"added_asc"

string

default:"mm-dd-yyyy"

End date

string

default:"1628008053263"

Start After

string

default:"UIaE1WjAwWKdlyD7osQI"

Start After Id

string

default:"mm-dd-yyyy"

Start date

string

default:"US"

number

number

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

boolean

default:"False"

get Tasks in contact

boolean

default:"False"

get Notes in contact

boolean

default:"False"

get Calendar event in contact

Respuestas

200 - Successful response

object[]

Show cada item

string

default:"yWQobCRIhRguQtD2llvk"

string

default:"testing"

number

default:"500"

string

default:"VDm7RPYC2GLUvdpKmBfC"

string

default:"e93ba61a-53b3-45e7-985a-c7732dbcdb69"

string

default:"zT46WSCPbudrq4zhWMk6"

string

default:"open"

string

default:""

string

default:"2021-08-03T04:55:17.355Z"

string

default:"2021-08-03T04:55:17.355Z"

string

default:"2021-08-03T04:55:17.355Z"

string

default:"1"

string

default:"2021-08-03T04:55:17.355Z"

string

default:"2021-08-03T04:55:17.355Z"

string

default:"zT46WSCPbudrq4zhWMk6"

string

default:"zT46WSCPbudrq4zhW"

object

Show propiedades

string

default:"byMEV0NQinDhq8ZfiOi2"

string

default:"John Deo"

string

default:"Tesla Inc"

string

default:"john@deo.com"

string

default:"+1202-555-0107"

string[]

array[]

array[]

array[]

string

default:"zT46WSCPbudrq4zhWMk6"

object[]

Show cada item

string

default:"MgobCB14YMVKuE4Ka8p1"

required

object

required

The value of the custom field

array[]

string

object

Show propiedades

number

default:"1"

string

string

default:"yWQobCRIhRguQtD2llvk"

number

default:"1625203104328"

number

default:"2"

number

default:"3"

number

default:"1"

object

{
  "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

{}

Ejemplo

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);