post
https://api.marketcircle.net/v1/companies/_search
Search for companies
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
See the search filtering documentation for details about the query syntax. The searchable attributes and the operators each one accepts are listed in the request body below.
Company-specific notes
- Email addresses are searched with the key
email_addresses, notemails:
{ "email_addresses": { "any": { "address": { "ends_with": "@example.com" } } } } - Phone numbers compare digits only, so
"905-555-0100"and"9055550100"match the same number. category,type,industryandregionmatch by name, e.g.{ "industry": { "equal": "Software" } }.- Contacts, opportunities and projects take a search filter for that record type with
any, so you can match by reference or by any of its attributes:
{ "contacts": { "any": { "contact": { "equal": "/v1/contacts/1000" } } } }
{ "contacts": { "any": { "last_name": { "equal": "Smith" } } } } - Linked records (
appointments,notes,tasks,groups,forms,email_messages) work the same way, using the linked record's reference:
{ "notes": { "any": { "note": { "equal": "/v1/notes/1000" } } } } rolematches the name of a role the company has with a contact, opportunity or project, e.g.{ "role": { "equal": "Customer" } }.imagecan only be searched withblankandnot_blank. As with all attributes, the value given toblankandnot_blankis ignored.companyandcompany_idmatch the company itself, by reference or by numeric ID.- Numbers must be sent as JSON numbers, e.g.
{ "number_of_employees": { "greater_than": 50 } }, not"50".
Related companies (the companies list on a company) can't be searched; use relationship search instead.