curl --request GET \
--url https://api.realtor.dit.myperch.io/v1/firmMembers/{id}/leads \
--header 'x-api-key: <api-key>'
{
"meta": {
"totalCount": 42
},
"data": [
{
"id": "g4XWxPqY",
"createdAt": "2025-07-22T21:17:14.867Z",
"updatedAt": "2025-07-22T21:17:14.867Z",
"deletedAt": null,
"email": "client1+21135778@example.com",
"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
},
{
"id": "7g83HRsK",
"createdAt": "2025-07-22T21:17:14.867Z",
"updatedAt": "2025-07-22T21:17:14.867Z",
"deletedAt": null,
"email": "client1+12469913@example.com",
"firstName": "Rollin",
"lastName": "Rohan",
"phone": {
"number": "4698180851",
"extension": "227"
},
"clientData": {
"sin": "334690890",
"prefix": "Ms.",
"citizenship": "Other",
"dateOfBirth": "1975-06-19",
"maritalStatus": "Widowed",
"creditScoreEstimation": "587"
},
"resourceType": "Firm",
"resourceId": "1EsP4fVX",
"referredByReferralCodeId": null,
"convertedAt": null
}
]
}
Gets a list of records from the Lead table based on passed parameters and implicit access controls.
curl --request GET \
--url https://api.realtor.dit.myperch.io/v1/firmMembers/{id}/leads \
--header 'x-api-key: <api-key>'
{
"meta": {
"totalCount": 42
},
"data": [
{
"id": "g4XWxPqY",
"createdAt": "2025-07-22T21:17:14.867Z",
"updatedAt": "2025-07-22T21:17:14.867Z",
"deletedAt": null,
"email": "client1+21135778@example.com",
"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
},
{
"id": "7g83HRsK",
"createdAt": "2025-07-22T21:17:14.867Z",
"updatedAt": "2025-07-22T21:17:14.867Z",
"deletedAt": null,
"email": "client1+12469913@example.com",
"firstName": "Rollin",
"lastName": "Rohan",
"phone": {
"number": "4698180851",
"extension": "227"
},
"clientData": {
"sin": "334690890",
"prefix": "Ms.",
"citizenship": "Other",
"dateOfBirth": "1975-06-19",
"maritalStatus": "Widowed",
"creditScoreEstimation": "587"
},
"resourceType": "Firm",
"resourceId": "1EsP4fVX",
"referredByReferralCodeId": null,
"convertedAt": null
}
]
}
The id of the record to retrieve.
"abc123"
Successful response
The response is of type object
.