Search for contacts by email, name, or company name

GET /contacts/v1/search/query

Method Details

HTTP Methods:

GET

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Yes

Headers

User-Agent

Products:

Marketing & CRM

For a given portal, return contacts and some data associated with those contacts by the contact's email address, first and last name, and company name.

Please note that you should expect this method to only return a small subset of data about the contact. One piece of data that the method will return is the contact ID (vid) that you can then use to look up much more data about that particular contact by its ID.

Required Parameters How to use Description
OAuth Access Token or API Key Authorization: Bearer {token} header
or hapikey={key} query parameter.
Used to authenticate the request. Please see this page for more details about authentication.
Search Query &q= - Used in the request URL The search term for what you're searching for. You can use all of a word or just parts of a word as well. For example, if you we're searching for contacts with "hubspot" in their name or email, searching for "hub" would also return contacts with "hubspot" in their email address.
Optional Parameters How to use Description
Count &count=X - Used in the request URL This parameter lets you specify the amount of contacts to return in your API call. The default for this parameter (if it isn't specified) is 20 contacts. The maximum amount of contacts you can have returned to you via this parameter is 100.
Offset &offset=X - Used in the request URL This parameter is used to page through the results. Every call to this endpoint will return an offset value. This value is used in the offset= parameter of the next call to get the next page of contacts.
Property &property=X - Used in the request URL If you include the "property" parameter, then the properties in the "contact" object in the returned data will only include the property or properties that you request.

Example URL:  https://api.hubapi.com/contacts/v1/search/query?q=testingapis&hapikey=demo