Skip to main content
GET
/
firms
/
{id}
/
leads
List Leads for Firm
curl --request GET \
  --url https://api.realtor.dit.myperch.io/v1/firms/{id}/leads \
  --header 'x-api-key: <api-key>'
{
  "meta": {
    "totalCount": 42
  },
  "data": [
    {
      "id": "3fvStz1j",
      "createdAt": "2026-01-13T21:34:54.135Z",
      "updatedAt": "2026-01-13T21:34:54.135Z",
      "deletedAt": null,
      "email": "[email protected]",
      "firstName": "Ambrose",
      "lastName": "Barton",
      "phone": {
        "number": "8265822123",
        "extension": "903"
      },
      "clientData": {
        "sin": "047470723",
        "prefix": "Ms.",
        "citizenship": "Permanent Legal Resident (PR)",
        "dateOfBirth": "1975-04-10",
        "maritalStatus": "Separated",
        "creditScoreEstimation": "899"
      },
      "resourceType": "Firm",
      "resourceId": "gk3Fhfi6",
      "referredByReferralCodeId": null,
      "convertedAt": null
    },
    {
      "id": "1SVFGm7k",
      "createdAt": "2026-01-13T21:34:54.135Z",
      "updatedAt": "2026-01-13T21:34:54.135Z",
      "deletedAt": null,
      "email": "[email protected]",
      "firstName": "Cierra",
      "lastName": "Mann",
      "phone": {
        "number": "6897659101",
        "extension": "982"
      },
      "clientData": {
        "sin": "280412358",
        "prefix": "Mr.",
        "citizenship": "Work VISA",
        "dateOfBirth": "1996-05-09",
        "maritalStatus": "Divorced",
        "creditScoreEstimation": "368"
      },
      "resourceType": "Firm",
      "resourceId": "6c17U3xf",
      "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

200 - application/json

Successful response

​
meta
object
​
data
object[]
Example:
[
  {
    "id": "3fvStz1j",
    "createdAt": "2026-01-13T21:34:54.135Z",
    "updatedAt": "2026-01-13T21:34:54.135Z",
    "deletedAt": null,
    "email": "[email protected]",
    "firstName": "Ambrose",
    "lastName": "Barton",
    "phone": {
      "number": "8265822123",
      "extension": "903"
    },
    "clientData": {
      "sin": "047470723",
      "prefix": "Ms.",
      "citizenship": "Permanent Legal Resident (PR)",
      "dateOfBirth": "1975-04-10",
      "maritalStatus": "Separated",
      "creditScoreEstimation": "899"
    },
    "resourceType": "Firm",
    "resourceId": "gk3Fhfi6",
    "referredByReferralCodeId": null,
    "convertedAt": null
  },
  {
    "id": "1SVFGm7k",
    "createdAt": "2026-01-13T21:34:54.135Z",
    "updatedAt": "2026-01-13T21:34:54.135Z",
    "deletedAt": null,
    "email": "[email protected]",
    "firstName": "Cierra",
    "lastName": "Mann",
    "phone": {
      "number": "6897659101",
      "extension": "982"
    },
    "clientData": {
      "sin": "280412358",
      "prefix": "Mr.",
      "citizenship": "Work VISA",
      "dateOfBirth": "1996-05-09",
      "maritalStatus": "Divorced",
      "creditScoreEstimation": "368"
    },
    "resourceType": "Firm",
    "resourceId": "6c17U3xf",
    "referredByReferralCodeId": null,
    "convertedAt": null
  }
]