> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.itspropel.com/llms.txt. > For full documentation content, see https://docs.itspropel.com/llms-full.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.itspropel.com/_mcp/server. # List Leads GET https://leads List Leads visible to the current tenant + tenant_location. **Query params (all optional):** - `assigned_user_id` (uuid): filter by assignee - `lead_stage_id` (uuid): filter by stage - `lead_source_id` (uuid): filter by source - `is_open` (bool): only non-terminal leads - `is_converted` (bool): only converted leads - `follow_up_due` (bool): only leads whose `follow_up_at` is past-due - `search` (string max 255): match name / business_name - `per_page` (int 1-100, default 15) - `cursor` (string): cursor pagination token Reference: https://docs.itspropel.com/propel-biz/34-leads/leads/34-leads-leads-crud/list-leads ## OpenAPI Specification ```yaml openapi: 3.1.0 info: title: PropelBiz version: 1.0.0 paths: /leads: get: operationId: list-leads summary: List Leads description: |- List Leads visible to the current tenant + tenant_location. **Query params (all optional):** - `assigned_user_id` (uuid): filter by assignee - `lead_stage_id` (uuid): filter by stage - `lead_source_id` (uuid): filter by source - `is_open` (bool): only non-terminal leads - `is_converted` (bool): only converted leads - `follow_up_due` (bool): only leads whose `follow_up_at` is past-due - `search` (string max 255): match name / business_name - `per_page` (int 1-100, default 15) - `cursor` (string): cursor pagination token tags: - >- subpackage_34Leads.subpackage_34Leads/leads.subpackage_34Leads/leads/34LeadsLeadsCrud parameters: - name: assigned_user_id in: query description: 'Optional: Assignee UUID' required: false schema: type: string - name: lead_stage_id in: query description: 'Optional: Lead stage UUID' required: false schema: type: string - name: lead_source_id in: query description: 'Optional: Lead source UUID' required: false schema: type: string - name: is_open in: query description: 'Optional: true|false' required: false schema: type: string - name: is_converted in: query description: 'Optional: true|false' required: false schema: type: string - name: follow_up_due in: query description: 'Optional: true|false' required: false schema: type: string - name: search in: query description: 'Optional: search term - max 255' required: false schema: type: string - name: per_page in: query description: 'Optional: Results per page (default 15, max 100)' required: false schema: type: integer - name: cursor in: query description: 'Optional: Cursor pagination token' required: false schema: type: string - name: '{{tenant_key_name}}' in: header required: false schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: >- #/components/schemas/34 Leads_Leads_34 Leads > Leads > CRUD_List Leads_Response_200 servers: - url: https:/ components: schemas: 34 Leads_Leads_34 Leads > Leads > CRUD_List Leads_Response_200: type: object properties: {} description: Empty response body title: 34 Leads_Leads_34 Leads > Leads > CRUD_List Leads_Response_200 ``` ## SDK Code Examples ```python import requests url = "https://https/leads" querystring = {"assigned_user_id":"d3b07384-d9a1-4f2a-8f3e-1a2b3c4d5e6f","lead_stage_id":"a1b2c3d4-e5f6-7a8b-9c0d-1e2f3a4b5c6d","lead_source_id":"f1e2d3c4-b5a6-7980-1b2c-3d4e5f6a7b8c","is_open":"true","is_converted":"false","follow_up_due":"true","search":"Acme Corporation","per_page":"20","cursor":"eyJjdXJzb3IiOiIxMjM0NTY3ODkwIn0="} payload = {} headers = { "{{tenant_key_name}}": "{{tenant_key_value1}}|{{tenant_key_value2}}", "Content-Type": "application/json" } response = requests.get(url, json=payload, headers=headers, params=querystring) print(response.json()) ``` ```javascript const url = 'https://https/leads?assigned_user_id=d3b07384-d9a1-4f2a-8f3e-1a2b3c4d5e6f&lead_stage_id=a1b2c3d4-e5f6-7a8b-9c0d-1e2f3a4b5c6d&lead_source_id=f1e2d3c4-b5a6-7980-1b2c-3d4e5f6a7b8c&is_open=true&is_converted=false&follow_up_due=true&search=Acme+Corporation&per_page=20&cursor=eyJjdXJzb3IiOiIxMjM0NTY3ODkwIn0%3D'; const options = { method: 'GET', headers: { '{{tenant_key_name}}': '{{tenant_key_value1}}|{{tenant_key_value2}}', 'Content-Type': 'application/json' }, body: '{}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://https/leads?assigned_user_id=d3b07384-d9a1-4f2a-8f3e-1a2b3c4d5e6f&lead_stage_id=a1b2c3d4-e5f6-7a8b-9c0d-1e2f3a4b5c6d&lead_source_id=f1e2d3c4-b5a6-7980-1b2c-3d4e5f6a7b8c&is_open=true&is_converted=false&follow_up_due=true&search=Acme+Corporation&per_page=20&cursor=eyJjdXJzb3IiOiIxMjM0NTY3ODkwIn0%3D" payload := strings.NewReader("{}") req, _ := http.NewRequest("GET", url, payload) req.Header.Add("{{tenant_key_name}}", "{{tenant_key_value1}}|{{tenant_key_value2}}") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://https/leads?assigned_user_id=d3b07384-d9a1-4f2a-8f3e-1a2b3c4d5e6f&lead_stage_id=a1b2c3d4-e5f6-7a8b-9c0d-1e2f3a4b5c6d&lead_source_id=f1e2d3c4-b5a6-7980-1b2c-3d4e5f6a7b8c&is_open=true&is_converted=false&follow_up_due=true&search=Acme+Corporation&per_page=20&cursor=eyJjdXJzb3IiOiIxMjM0NTY3ODkwIn0%3D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["{{tenant_key_name}}"] = '{{tenant_key_value1}}|{{tenant_key_value2}}' request["Content-Type"] = 'application/json' request.body = "{}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://https/leads?assigned_user_id=d3b07384-d9a1-4f2a-8f3e-1a2b3c4d5e6f&lead_stage_id=a1b2c3d4-e5f6-7a8b-9c0d-1e2f3a4b5c6d&lead_source_id=f1e2d3c4-b5a6-7980-1b2c-3d4e5f6a7b8c&is_open=true&is_converted=false&follow_up_due=true&search=Acme+Corporation&per_page=20&cursor=eyJjdXJzb3IiOiIxMjM0NTY3ODkwIn0%3D") .header("{{tenant_key_name}}", "{{tenant_key_value1}}|{{tenant_key_value2}}") .header("Content-Type", "application/json") .body("{}") .asString(); ``` ```php request('GET', 'https://https/leads?assigned_user_id=d3b07384-d9a1-4f2a-8f3e-1a2b3c4d5e6f&lead_stage_id=a1b2c3d4-e5f6-7a8b-9c0d-1e2f3a4b5c6d&lead_source_id=f1e2d3c4-b5a6-7980-1b2c-3d4e5f6a7b8c&is_open=true&is_converted=false&follow_up_due=true&search=Acme+Corporation&per_page=20&cursor=eyJjdXJzb3IiOiIxMjM0NTY3ODkwIn0%3D', [ 'body' => '{}', 'headers' => [ 'Content-Type' => 'application/json', '{{tenant_key_name}}' => '{{tenant_key_value1}}|{{tenant_key_value2}}', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://https/leads?assigned_user_id=d3b07384-d9a1-4f2a-8f3e-1a2b3c4d5e6f&lead_stage_id=a1b2c3d4-e5f6-7a8b-9c0d-1e2f3a4b5c6d&lead_source_id=f1e2d3c4-b5a6-7980-1b2c-3d4e5f6a7b8c&is_open=true&is_converted=false&follow_up_due=true&search=Acme+Corporation&per_page=20&cursor=eyJjdXJzb3IiOiIxMjM0NTY3ODkwIn0%3D"); var request = new RestRequest(Method.GET); request.AddHeader("{{tenant_key_name}}", "{{tenant_key_value1}}|{{tenant_key_value2}}"); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "{{tenant_key_name}}": "{{tenant_key_value1}}|{{tenant_key_value2}}", "Content-Type": "application/json" ] let parameters = [] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://https/leads?assigned_user_id=d3b07384-d9a1-4f2a-8f3e-1a2b3c4d5e6f&lead_stage_id=a1b2c3d4-e5f6-7a8b-9c0d-1e2f3a4b5c6d&lead_source_id=f1e2d3c4-b5a6-7980-1b2c-3d4e5f6a7b8c&is_open=true&is_converted=false&follow_up_due=true&search=Acme+Corporation&per_page=20&cursor=eyJjdXJzb3IiOiIxMjM0NTY3ODkwIn0%3D")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```