curl --request POST \
--url https://api.realtor.dit.myperch.io/v1/firms/{id}/leads \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"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"
}
'{
"data": {
"id": "38owigkM",
"createdAt": "2026-03-05T19:39:18.389Z",
"updatedAt": "2026-03-05T19:39:18.389Z",
"email": "client1+74049788@example.com",
"firstName": "Amya",
"lastName": "Williamson",
"resourceType": "Firm",
"resourceId": "qSBKZzUi",
"deletedAt": "2023-11-07T05:31:56Z",
"phone": {
"number": "<string>",
"extension": "<string>"
},
"clientData": {
"advisorProfileId": "<string>",
"citizenship": "Canadian Citizen",
"creditScoreEstimation": "700",
"dateOfBirth": "1980-01-01",
"isFirstTimeHomeBuyer": true,
"maritalStatus": "Married",
"prefix": "Mrs.",
"sin": "123456789",
"Assets": [
{
"type": "Savings",
"description": "Savings account at RBC",
"value": 10000
}
],
"Incomes": [
{
"type": "Employment",
"startedOn": "2018-01-01",
"endedOn": "2022-12-31",
"description": "Cyberdyne Systems",
"streams": {},
"employmentDetails": {
"type": "Salaried",
"jobTitle": "Accountant",
"phone": "{\"number\":\"6471234567\",\"extension\":\"123\"}",
"sector": "Financial Services",
"businessName": "Acme Inc.",
"address": {
"unitNumber": "<string>",
"streetNumber": "<string>",
"streetName": "<string>",
"locality": "<string>",
"administrativeArea": "<string>",
"postalCode": "<string>",
"country": "<string>",
"premise": "<string>",
"googlePlaceId": "<string>",
"locationGeometry": "{\"type\":\"Point\",\"coordinates\":[-79.3832,43.6532]}"
},
"businessType": "Sole Proprietorship",
"businessEstablishedOn": "2019-01-01",
"businessAnnualGrossRevenue": "10000",
"probationEndsOn": "2022-01-01"
}
}
],
"ClientResidencies": [
{
"occupancyType": "Resider",
"startsOn": "2018-01-01",
"locality": "<string>",
"administrativeArea": "<string>",
"postalCode": "<string>",
"country": "<string>",
"endsOn": "2022-12-31",
"monthlyRent": 2000,
"unitNumber": "<string>",
"streetNumber": "<string>",
"streetName": "<string>",
"premise": "<string>",
"googlePlaceId": "<string>",
"locationGeometry": "{\"type\":\"Point\",\"coordinates\":[-79.3832,43.6532]}"
}
],
"Plans": [
{
"type": "Buying",
"id": "<string>",
"leadId": "<string>",
"referralCodeId": "<string>",
"realtorProfileId": "<string>"
}
],
"Properties": [
{
"type": "Detached",
"status": "Owned",
"occupancyType": "Owner Occupied",
"purchasePrice": 500000,
"purchasedOn": "2018-01-01",
"monthlyTotalRent": 2000,
"costs": {
"annualPropertyTaxes": 123,
"monthlyMaintenanceFee": 123
},
"unitNumber": "<string>",
"streetNumber": "<string>",
"streetName": "<string>",
"locality": "<string>",
"administrativeArea": "<string>",
"postalCode": "<string>",
"country": "<string>",
"premise": "<string>",
"googlePlaceId": "<string>",
"locationGeometry": "{\"type\":\"Point\",\"coordinates\":[-79.3832,43.6532]}",
"Liabilities": [
{
"type": "Alimony",
"balance": "<string>",
"creditLimit": "<string>",
"lenderName": "<string>",
"maturesOn": "2023-12-25",
"paymentAmount": "<string>",
"paymentDetails": {
"isInterestOnly": true,
"isPropertyTaxIncluded": true
},
"paymentFrequency": "Weekly",
"rate": 123,
"rateType": "Fixed",
"description": "<string>",
"termMonths": 123,
"position": 123,
"ChildLiabilities": [
{
"type": "HELOC",
"balance": "<string>",
"creditLimit": "<string>",
"lenderName": "<string>",
"maturesOn": "2023-12-25",
"paymentAmount": "<string>",
"paymentDetails": {
"isInterestOnly": true,
"isPropertyTaxIncluded": true
},
"paymentFrequency": "Weekly",
"rate": 123,
"rateType": "Fixed",
"description": "<string>",
"termMonths": 123
}
]
}
]
}
],
"notes": "<string>"
},
"referredByReferralCodeId": "<string>",
"convertedAt": "2023-11-07T05:31:56Z"
}
}Creates a record in the Lead table based on passed parameters and implicit access controls.
curl --request POST \
--url https://api.realtor.dit.myperch.io/v1/firms/{id}/leads \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"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"
}
'{
"data": {
"id": "38owigkM",
"createdAt": "2026-03-05T19:39:18.389Z",
"updatedAt": "2026-03-05T19:39:18.389Z",
"email": "client1+74049788@example.com",
"firstName": "Amya",
"lastName": "Williamson",
"resourceType": "Firm",
"resourceId": "qSBKZzUi",
"deletedAt": "2023-11-07T05:31:56Z",
"phone": {
"number": "<string>",
"extension": "<string>"
},
"clientData": {
"advisorProfileId": "<string>",
"citizenship": "Canadian Citizen",
"creditScoreEstimation": "700",
"dateOfBirth": "1980-01-01",
"isFirstTimeHomeBuyer": true,
"maritalStatus": "Married",
"prefix": "Mrs.",
"sin": "123456789",
"Assets": [
{
"type": "Savings",
"description": "Savings account at RBC",
"value": 10000
}
],
"Incomes": [
{
"type": "Employment",
"startedOn": "2018-01-01",
"endedOn": "2022-12-31",
"description": "Cyberdyne Systems",
"streams": {},
"employmentDetails": {
"type": "Salaried",
"jobTitle": "Accountant",
"phone": "{\"number\":\"6471234567\",\"extension\":\"123\"}",
"sector": "Financial Services",
"businessName": "Acme Inc.",
"address": {
"unitNumber": "<string>",
"streetNumber": "<string>",
"streetName": "<string>",
"locality": "<string>",
"administrativeArea": "<string>",
"postalCode": "<string>",
"country": "<string>",
"premise": "<string>",
"googlePlaceId": "<string>",
"locationGeometry": "{\"type\":\"Point\",\"coordinates\":[-79.3832,43.6532]}"
},
"businessType": "Sole Proprietorship",
"businessEstablishedOn": "2019-01-01",
"businessAnnualGrossRevenue": "10000",
"probationEndsOn": "2022-01-01"
}
}
],
"ClientResidencies": [
{
"occupancyType": "Resider",
"startsOn": "2018-01-01",
"locality": "<string>",
"administrativeArea": "<string>",
"postalCode": "<string>",
"country": "<string>",
"endsOn": "2022-12-31",
"monthlyRent": 2000,
"unitNumber": "<string>",
"streetNumber": "<string>",
"streetName": "<string>",
"premise": "<string>",
"googlePlaceId": "<string>",
"locationGeometry": "{\"type\":\"Point\",\"coordinates\":[-79.3832,43.6532]}"
}
],
"Plans": [
{
"type": "Buying",
"id": "<string>",
"leadId": "<string>",
"referralCodeId": "<string>",
"realtorProfileId": "<string>"
}
],
"Properties": [
{
"type": "Detached",
"status": "Owned",
"occupancyType": "Owner Occupied",
"purchasePrice": 500000,
"purchasedOn": "2018-01-01",
"monthlyTotalRent": 2000,
"costs": {
"annualPropertyTaxes": 123,
"monthlyMaintenanceFee": 123
},
"unitNumber": "<string>",
"streetNumber": "<string>",
"streetName": "<string>",
"locality": "<string>",
"administrativeArea": "<string>",
"postalCode": "<string>",
"country": "<string>",
"premise": "<string>",
"googlePlaceId": "<string>",
"locationGeometry": "{\"type\":\"Point\",\"coordinates\":[-79.3832,43.6532]}",
"Liabilities": [
{
"type": "Alimony",
"balance": "<string>",
"creditLimit": "<string>",
"lenderName": "<string>",
"maturesOn": "2023-12-25",
"paymentAmount": "<string>",
"paymentDetails": {
"isInterestOnly": true,
"isPropertyTaxIncluded": true
},
"paymentFrequency": "Weekly",
"rate": 123,
"rateType": "Fixed",
"description": "<string>",
"termMonths": 123,
"position": 123,
"ChildLiabilities": [
{
"type": "HELOC",
"balance": "<string>",
"creditLimit": "<string>",
"lenderName": "<string>",
"maturesOn": "2023-12-25",
"paymentAmount": "<string>",
"paymentDetails": {
"isInterestOnly": true,
"isPropertyTaxIncluded": true
},
"paymentFrequency": "Weekly",
"rate": 123,
"rateType": "Fixed",
"description": "<string>",
"termMonths": 123
}
]
}
]
}
],
"notes": "<string>"
},
"referredByReferralCodeId": "<string>",
"convertedAt": "2023-11-07T05:31:56Z"
}
}The id of the record to retrieve.
"abc123"
The data to create the record with.
The client's email address
"client1+74049788@example.com"
The client's first name
"Amya"
The client's last name
"Williamson"
The resource type of the lead owner
ClientProfile, Firm, FirmMember "Firm"
The resource ID of the lead owner
"qSBKZzUi"
The client's phone number
Show child attributes
The user data for the lead
Show child attributes
Successful response
Show child attributes