Leads
Get Leads
Leads
Get Leads
Fetch leads
GET
/
leads
curl --request GET \
--url https://app.planpoint.io/api/leads \
--header 'Authorization: <api-key>'
[
{
"firstName": "<string>",
"lastName": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"unit": "<string>",
"message": "<string>",
"source": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"questions": [
{
"question": "<string>",
"answer": "<string>"
}
],
"customFields": [
{
"key": "<string>",
"value": "<string>"
}
]
}
]
Authorizations
Query Parameters
Use a project ID to search for leads
Example:
"objectId"
Response
200
application/json
Array of leads found
The response is of type object[]
.
curl --request GET \
--url https://app.planpoint.io/api/leads \
--header 'Authorization: <api-key>'
[
{
"firstName": "<string>",
"lastName": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"unit": "<string>",
"message": "<string>",
"source": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"questions": [
{
"question": "<string>",
"answer": "<string>"
}
],
"customFields": [
{
"key": "<string>",
"value": "<string>"
}
]
}
]