Skip to main content
GET
/
leads
/
{id}
Read Lead
curl --request GET \
  --url https://api.partner.dit.myperch.io/v1/leads/{id} \
  --header 'x-api-key: <api-key>'
import requests

url = "https://api.partner.dit.myperch.io/v1/leads/{id}"

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://api.partner.dit.myperch.io/v1/leads/{id}', 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.partner.dit.myperch.io/v1/leads/{id}",
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://api.partner.dit.myperch.io/v1/leads/{id}"

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://api.partner.dit.myperch.io/v1/leads/{id}")
.header("x-api-key", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.partner.dit.myperch.io/v1/leads/{id}")

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": "38owigkM",
    "createdAt": "2026-03-05T19:39:18.389Z",
    "updatedAt": "2026-03-05T19:39:18.389Z",
    "deletedAt": null,
    "email": "client1+74049788@example.com",
    "firstName": "Amya",
    "lastName": "Williamson",
    "phone": {
      "number": "2925655632",
      "extension": "562"
    },
    "clientData": {
      "sin": "004877852",
      "prefix": "Ms.",
      "citizenship": "Permanent Legal Resident (PR)",
      "dateOfBirth": "1987-07-13",
      "maritalStatus": "Married",
      "creditScoreEstimation": "142"
    },
    "resourceType": "Firm",
    "resourceId": "qSBKZzUi",
    "referredByReferralCodeId": null,
    "convertedAt": null
  }
}

Authorizations

x-api-key
string
header
required

Path Parameters

id
string
required

The id of the record to retrieve.

Example:

"abc123"

Response

Successful response

data
object