List Discover leads
curl --request GET \
--url https://app.sideshift.app/api/v1/discover/leads \
--header 'x-api-key: <api-key>'import requests
url = "https://app.sideshift.app/api/v1/discover/leads"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://app.sideshift.app/api/v1/discover/leads', 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://app.sideshift.app/api/v1/discover/leads",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$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://app.sideshift.app/api/v1/discover/leads"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.sideshift.app/api/v1/discover/leads")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.sideshift.app/api/v1/discover/leads")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "<string>",
"status": "new",
"submittedAt": "2023-11-07T05:31:56Z",
"statusUpdatedAt": "2023-11-07T05:31:56Z",
"listing": {
"id": "<string>",
"title": "<string>",
"formTitle": "<string>"
},
"contact": {
"name": "<string>",
"email": "<string>",
"phone": "<string>"
},
"company": {
"id": "<string>",
"name": "<string>",
"website": "<string>",
"appstoreUrl": "<string>",
"avatarUrl": "<string>",
"type": "<string>"
},
"agency": {
"id": "<string>",
"name": "<string>",
"avatarUrl": "<string>"
},
"answers": [
{
"fieldId": "<string>",
"label": "<string>",
"type": "<string>",
"required": true,
"value": "<unknown>",
"displayValue": "<string>"
}
],
"leadForm": {
"fields": [
{
"id": "<string>",
"label": "<string>",
"type": "<string>",
"required": true,
"description": "<string>",
"options": [
{
"id": "<string>",
"label": "<string>"
}
]
}
]
},
"engagement": {
"messageCount": 123,
"callCount": 123,
"lastMessageAt": "2023-11-07T05:31:56Z",
"lastCallAt": "2023-11-07T05:31:56Z",
"lastEngagedAt": "2023-11-07T05:31:56Z"
}
}
],
"page": 123,
"limit": 123,
"total": 123
}List Discover leads
List the Discover leads (brand inquiries) submitted to your agency, ordered newest-first. Each lead includes:
- the brand’s contact details and submitted lead-form
answers, - the lead-form field definitions (
leadForm.fields) so you can map each answer back to its question, - the submitting brand’s
companyprofile (joined live from the brand’s workspace where available, otherwise the values captured at submit time), - lightweight
engagementcounters (messages, calls).
Results are scoped to the authenticated company — you can only read leads that belong to your agency. Duplicate interaction records for the same brand + listing are collapsed into a single lead.
GET
/
discover
/
leads
List Discover leads
curl --request GET \
--url https://app.sideshift.app/api/v1/discover/leads \
--header 'x-api-key: <api-key>'import requests
url = "https://app.sideshift.app/api/v1/discover/leads"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://app.sideshift.app/api/v1/discover/leads', 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://app.sideshift.app/api/v1/discover/leads",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$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://app.sideshift.app/api/v1/discover/leads"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.sideshift.app/api/v1/discover/leads")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.sideshift.app/api/v1/discover/leads")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "<string>",
"status": "new",
"submittedAt": "2023-11-07T05:31:56Z",
"statusUpdatedAt": "2023-11-07T05:31:56Z",
"listing": {
"id": "<string>",
"title": "<string>",
"formTitle": "<string>"
},
"contact": {
"name": "<string>",
"email": "<string>",
"phone": "<string>"
},
"company": {
"id": "<string>",
"name": "<string>",
"website": "<string>",
"appstoreUrl": "<string>",
"avatarUrl": "<string>",
"type": "<string>"
},
"agency": {
"id": "<string>",
"name": "<string>",
"avatarUrl": "<string>"
},
"answers": [
{
"fieldId": "<string>",
"label": "<string>",
"type": "<string>",
"required": true,
"value": "<unknown>",
"displayValue": "<string>"
}
],
"leadForm": {
"fields": [
{
"id": "<string>",
"label": "<string>",
"type": "<string>",
"required": true,
"description": "<string>",
"options": [
{
"id": "<string>",
"label": "<string>"
}
]
}
]
},
"engagement": {
"messageCount": 123,
"callCount": 123,
"lastMessageAt": "2023-11-07T05:31:56Z",
"lastCallAt": "2023-11-07T05:31:56Z",
"lastEngagedAt": "2023-11-07T05:31:56Z"
}
}
],
"page": 123,
"limit": 123,
"total": 123
}Authorizations
API key for authentication. Get yours from Settings → Integrations. A key created by a team member acts as that member and follows their current team permissions; a request outside those permissions returns 403 { "error": "insufficient_scope", "scope": "<required>" }.
Query Parameters
Required range:
x >= 1Required range:
1 <= x <= 100Filter by lead status.
Available options:
new, contacted, call_booked, proposal_sent, won, lost, unqualified, nurture, all