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

Authorization
string
header
required

Query Parameters

pid
string

Use a project ID to search for leads

Example:

"objectId"

Response

200
application/json
Array of leads found
firstName
string

First name of the lead

lastName
string

Last name of the lead

email
string

Email address of the lead

phone
string

Phone number of the lead

unit
string

Unit associated with the lead

message
string

Message provided by the lead

source
string

Source of the lead

createdAt
string

Timestamp when the lead was created

questions
object[]

List of questions and their corresponding answers

customFields
object[]

List of custom fields and their values