Using the Search api

[HNunez]

Hi there! I was wondering if there is anyone out there that can help me using the Search api. When I use the the filterGroups parameter I get an error with the "operator" params. I have tried all the avaliable options for its value and even I tried setting it at null and still I get errors. Can someone help me please??

const PublicObjectSearchRequest = { filterGroups: [{"filters":[{"value":"string","propertyName":"string","operator":"EQ"}]}], sorts: ["string"], query: "string", properties: ["string"], limit: 0, after: 0 };

[HNunez]

Thank You!!!!!! @Teun 

[Teun · Accepted solution]

Hi @HNunez ,

I tested the code below and it should work:

const hubspot = require('@hubspot/api-client');

const hubspotClient = new hubspot.Client({"apiKey":"YOUR_HUBSPOT_API_KEY"});

const PublicObjectSearchRequest = { filterGroups: [{"filters":[{"value":"Teun","propertyName":"firstname","operator":"EQ"}]}], sorts: ["firstname"], properties: [["firstname","lastname"]], limit: 0, after: 0 };

try {
  const apiResponse = await hubspotClient.crm.contacts.searchApi.doSearch(PublicObjectSearchRequest);
  console.log(JSON.stringify(apiResponse.body, null, 2));
} catch (e) {
  e.message === 'HTTP request failed'
    ? console.error(JSON.stringify(e.response, null, 2))
    : console.error(e)
}

Did you fill in all the required params?

[RVu]

Does this work for custom properties added to a contact?

For example:

{ filterGroups: [{"filters":[{"value": "X3vsi8", "propertyName":"app_user_id", "operator": "EQ"}] }

Does this search api cover custom fields? And what if our custom field is required - does this change anything?