Authorizations
Path Parameters
Example:
curl --request GET \
--url https://api.realtor.dit.myperch.io/v1/leads/{id} \
--header 'x-api-key: <api-key>'{
"data": {
"id": "g4XWxPqY",
"createdAt": "2025-07-22T21:17:14.867Z",
"updatedAt": "2025-07-22T21:17:14.867Z",
"deletedAt": null,
"email": "[email protected]",
"firstName": "Natasha",
"lastName": "Blick",
"phone": {
"number": "2534062008",
"extension": "841"
},
"clientData": {
"sin": "970886723",
"prefix": "Mr.",
"citizenship": "Canadian Citizen",
"dateOfBirth": "1958-05-03",
"maritalStatus": "Single",
"creditScoreEstimation": "789"
},
"resourceType": "Firm",
"resourceId": "j86ZGq9d",
"referredByReferralCodeId": null,
"convertedAt": null
}
}Gets a record from the Lead table based on passed parameters and implicit access controls.
curl --request GET \
--url https://api.realtor.dit.myperch.io/v1/leads/{id} \
--header 'x-api-key: <api-key>'{
"data": {
"id": "g4XWxPqY",
"createdAt": "2025-07-22T21:17:14.867Z",
"updatedAt": "2025-07-22T21:17:14.867Z",
"deletedAt": null,
"email": "[email protected]",
"firstName": "Natasha",
"lastName": "Blick",
"phone": {
"number": "2534062008",
"extension": "841"
},
"clientData": {
"sin": "970886723",
"prefix": "Mr.",
"citizenship": "Canadian Citizen",
"dateOfBirth": "1958-05-03",
"maritalStatus": "Single",
"creditScoreEstimation": "789"
},
"resourceType": "Firm",
"resourceId": "j86ZGq9d",
"referredByReferralCodeId": null,
"convertedAt": null
}
}Show child attributes