Search for contacts
Available Response Fields
When making a GET request to /v1/people, not all available fields are included in the response by default. Use the ?fields= argument to request exactly the fields you need. You can use ?fields=allFields during development to get all fields returned, but this may return very large responses so please update this to specify exactly the fields you need for your production deployments.
Including Relationships
You do not need to perform separate calls to /v1/peopleRelationships to gather those associations. Include
relationshipsin thefieldsquery parameter to include relationship information. Depending on your use case you may not need this information and therefore it is excluded by default.
Determining Lead Type
If you are trying to determine the lead type, such as "Buyer" or "Seller", this can be done by looks at the returned tags. If the lead is a "Seller" type, there will be a "Seller" tag initially set when the lead is created, otherwise the lead is a "Buyer".
People response fields
Response Key | Description |
|---|---|
createdVia | This value indicates how this person was created. Possible values include "API", "Email Parsing", "Historic Email Parsing", "Import", and "Manually". |