v1
latestSwagger 2.02026-08-065854114.9 KBList and search for organizations.
Query parameters
Page of results to fetch.
Number of results to return per page.
Name prefix.
Name (exactly equal).
Category ID.
Sector ID.
Lead origin ID.
Array of product IDs.
Owner user ID.
Document number (CNPJ) prefix.
Author user 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 organizations that were created after this date.
Use to search for organizations that were created before this date.
Use to search for organizations that were updated after this date.
Use to search for organizations that were updated before this date.
Return custom fields of organizations. Use this param to include them in the response. Example: /organizations?withCustomFields=true
Response
OK
Example response
{
"data": [
{
"contact": {
"work": "(99) 9999-9999",
"mobile": "(99) 99999-9999",
"whatsapp": "+5511999999999"
},
"address": {
"postalCode": "99999-999"
}
}
]
}