Leads — SpiderIQ

GET/api/v1/leads

List Leads

List leads with pagination, search, and filters.

Parameters

Name	In	Type	Required
`page`	query	integer	false
`page_size`	query	integer	false
`search`	query	any	false
`source`	query	any	false
`has_email`	query	any	false
`has_verified_email`	query	any	false
`country_code`	query	any	false
`workflow_stage`	query	any	false
`sort_by`	query	string	false
`sort_dir`	query	string	false

Try it

Examples

cURL

curl -X GET 'https://spideriq.ai/api/v1/leads' \
  -H 'Authorization: Bearer <token>'

Python

import httpx

resp = httpx.get(
    "https://spideriq.ai/api/v1/leads",
    headers={"Authorization": "Bearer <token>"},
)
resp.raise_for_status()
print(resp.json())

JavaScript

const resp = await fetch("https://spideriq.ai/api/v1/leads", {
  method: "GET",
  headers: { "Authorization": "Bearer <token>" }
});
const data = await resp.json();
console.log(data);

Go

package main

import (
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://spideriq.ai/api/v1/leads", nil)
	req.Header.Set("Authorization", "Bearer <token>")
	resp, _ := http.DefaultClient.Do(req)
	defer resp.Body.Close()
}

Responses

Status	Description
`200`	Successful Response
`422`	Validation Error

GET/api/v1/leads/stats

Lead Stats

KPI counts.

Try it

Examples

cURL

curl -X GET 'https://spideriq.ai/api/v1/leads/stats' \
  -H 'Authorization: Bearer <token>'

Python

import httpx

resp = httpx.get(
    "https://spideriq.ai/api/v1/leads/stats",
    headers={"Authorization": "Bearer <token>"},
)
resp.raise_for_status()
print(resp.json())

JavaScript

const resp = await fetch("https://spideriq.ai/api/v1/leads/stats", {
  method: "GET",
  headers: { "Authorization": "Bearer <token>" }
});
const data = await resp.json();
console.log(data);

Go

package main

import (
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://spideriq.ai/api/v1/leads/stats", nil)
	req.Header.Set("Authorization", "Bearer <token>")
	resp, _ := http.DefaultClient.Do(req)
	defer resp.Body.Close()
}

Responses

Status	Description
`200`	Successful Response

GET/api/v1/leads/export

Export Leads

Export leads as CSV or JSON.

Parameters

Name	In	Type	Required	Description
`format`	query	any	false	`csv` (default) returns a CSV attachment; `json` and `llm` return the JSON body. `llm` is a member because `middleware/format_llm.py` tells every Bearer agent to send it — before `SDS-33` it 422'd here.
`source`	query	any	false
`country_code`	query	any	false

Try it

Examples

cURL

curl -X GET 'https://spideriq.ai/api/v1/leads/export' \
  -H 'Authorization: Bearer <token>'

Python

import httpx

resp = httpx.get(
    "https://spideriq.ai/api/v1/leads/export",
    headers={"Authorization": "Bearer <token>"},
)
resp.raise_for_status()
print(resp.json())

JavaScript

const resp = await fetch("https://spideriq.ai/api/v1/leads/export", {
  method: "GET",
  headers: { "Authorization": "Bearer <token>" }
});
const data = await resp.json();
console.log(data);

Go

package main

import (
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://spideriq.ai/api/v1/leads/export", nil)
	req.Header.Set("Authorization", "Bearer <token>")
	resp, _ := http.DefaultClient.Do(req)
	defer resp.Body.Close()
}

Responses

Status	Description
`200`	Successful Response
`422`	Validation Error

GET/api/v1/leads/{lead_id}

Get Lead

Full lead detail.

Parameters

Name	In	Type	Required	Description
`lead_id`	path	integer	true

Try it

Examples

cURL

curl -X GET 'https://spideriq.ai/api/v1/leads/{lead_id}' \
  -H 'Authorization: Bearer <token>'

Python

import httpx

resp = httpx.get(
    "https://spideriq.ai/api/v1/leads/{lead_id}",
    headers={"Authorization": "Bearer <token>"},
)
resp.raise_for_status()
print(resp.json())

JavaScript

const resp = await fetch("https://spideriq.ai/api/v1/leads/{lead_id}", {
  method: "GET",
  headers: { "Authorization": "Bearer <token>" }
});
const data = await resp.json();
console.log(data);

Go

package main

import (
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://spideriq.ai/api/v1/leads/{lead_id}", nil)
	req.Header.Set("Authorization", "Bearer <token>")
	resp, _ := http.DefaultClient.Do(req)
	defer resp.Body.Close()
}

Responses

Status	Description
`200`	Successful Response
`422`	Validation Error