List Deals
curl --request GET \
--url https://api.example.com/v1/dealsimport requests
url = "https://api.example.com/v1/deals"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/v1/deals', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/v1/deals",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v1/deals"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/v1/deals")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/deals")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"data": {
"deals": [
{
"id": "<string>",
"name": "<string>",
"stage": "<string>",
"status": "<string>",
"pipeline": "<string>",
"estimated_value": 123,
"main_contact_id": "<string>",
"owner_user_id": "<string>",
"priority": "<string>",
"matter_type": "<string>",
"tags": [
{}
],
"related_company_id": "<string>",
"high_level_description": "<string>",
"next_follow_up_date": "<string>",
"fee_model": "<string>",
"probability": 123,
"currency": "<string>",
"closed_date": "<string>",
"created_date": "<string>",
"updated_date": "<string>"
}
]
},
"meta": {
"page": 123,
"per_page": 123,
"total": 123
}
}Deals
List Deals
Retrieve a paginated list of deals in your workspace
GET
/
v1
/
deals
List Deals
curl --request GET \
--url https://api.example.com/v1/dealsimport requests
url = "https://api.example.com/v1/deals"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/v1/deals', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/v1/deals",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v1/deals"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/v1/deals")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/deals")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"data": {
"deals": [
{
"id": "<string>",
"name": "<string>",
"stage": "<string>",
"status": "<string>",
"pipeline": "<string>",
"estimated_value": 123,
"main_contact_id": "<string>",
"owner_user_id": "<string>",
"priority": "<string>",
"matter_type": "<string>",
"tags": [
{}
],
"related_company_id": "<string>",
"high_level_description": "<string>",
"next_follow_up_date": "<string>",
"fee_model": "<string>",
"probability": 123,
"currency": "<string>",
"closed_date": "<string>",
"created_date": "<string>",
"updated_date": "<string>"
}
]
},
"meta": {
"page": 123,
"per_page": 123,
"total": 123
}
}Request
Query Parameters
integer
default:"1"
Page number for pagination
integer
default:"50"
Number of deals per page (max: 100)
string
Filter by status (e.g.,
active, won, lost)string
Filter by pipeline name
string
Filter by stage name
string
Filter by main contact ID
string
Filter by deal owner user ID
string
Filter by tag
string
Filter deals created after this date (ISO 8601)
string
Filter deals created before this date (ISO 8601)
string
Filter deals updated after this date (ISO 8601)
Headers
Authorization: Bearer wbk_your_api_key_here
Response
object
Show properties
Show properties
array
Array of deal objects
Show Deal object
Show Deal object
string
Unique deal ID (UUID)
string
Deal name
string
Current stage
string
Deal status
string
Pipeline name
number
Estimated deal value
string
Primary contact ID
string
Deal owner user ID
string
Priority level
string
Deal/matter type
array
Tags
string
Related company ID
string
Description
string
Next follow-up date
string
Fee/service model
number
Win probability (0-100)
string
Currency code
string
Date deal was closed
string
ISO 8601 timestamp
string
ISO 8601 timestamp
object
curl https://data.leadlex.com/functions/v1/api-gateway/v1/deals \
-H "Authorization: Bearer wbk_your_api_key_here"
import requests
API_KEY = "wbk_your_api_key_here"
BASE_URL = "https://data.leadlex.com/functions/v1/api-gateway"
headers = {"Authorization": f"Bearer {API_KEY}"}
response = requests.get(f"{BASE_URL}/v1/deals", headers=headers)
deals = response.json()["data"]["deals"]
const response = await fetch(
'https://data.leadlex.com/functions/v1/api-gateway/v1/deals',
{ headers: { 'Authorization': 'Bearer wbk_your_api_key_here' } }
);
const { data } = await response.json();
Example Response
{
"data": {
"deals": [
{
"id": "deal-001",
"name": "Acme Corp Partnership",
"stage": "Proposal",
"status": "active",
"pipeline": "Sales",
"estimated_value": 50000,
"main_contact_id": "contact-001",
"owner_user_id": "user-001",
"priority": "high",
"matter_type": "partnership",
"tags": ["enterprise"],
"probability": 60,
"currency": "USD",
"created_date": "2026-03-01T10:00:00Z",
"updated_date": "2026-03-05T14:00:00Z"
}
]
},
"meta": { "page": 1, "per_page": 50, "total": 23 }
}
Errors
| Status | Code | Description |
|---|---|---|
| 401 | invalid_key | Invalid or expired API key |
| 403 | insufficient_permissions | Missing deals:read permission |
| 429 | rate_limited | Rate limit exceeded |