v1
latestSwagger 2.02026-08-065854114.9 KBList and search for people.
Query parameters
Page of results to fetch.
Number of results to return per page.
Name prefix.
Category ID.
Lead origin ID.
Array of product IDS.
Author user ID.
Owner user ID.
Role prefix.
Document number (CPF) prefix.
Organization ID.
Address state abbreviation.
City name prefix.
District name prefix.
Contact email prefix.
Work phone number.
Mobile phone number.
Fax number.
WhatsApp phone number.
Use to search in any phone field (work, mobile, fax and WhatsApp).
Use to search for people that were created after this date.
Use to search for people that were created before this date.
Use to search for people that were updated after this date.
Use to search for people that were updated before this date.
Return custom fields of people. Use this param to include them in the response. Example: /people?withCustomFields=true
Response
OK
Example response
{
"data": [
{
"contact": {
"work": "(99) 9999-9999",
"mobile": "(99) 99999-9999",
"whatsapp": "+5511999999999"
},
"address": {
"postalCode": "99999-999"
}
}
]
}