[Feature New API] Businesses Search and Custom Fields

[dimmisel]

🌟 Describe the Feature

Business cannot be searched and check if you have created already one.
Also, you cannot add or see custom Fields of business via API.

🚀 Justification

I just try to migrate from Pipedrive and this task blocked me.
A developer who want to automate lead generation via APIs cannot search if a business already exists, either by its name or ideally as Pipedrive via also custom field.

Also, a developer cannot add or edit custom field. e.g. of useful custom fields VAT, revenue per year, number of employees

📝 Suggestions

I have written before this.

🧠 Additional Context

These extra calls for businesses and also a way to find easily all custom fields API ids will expand your API usage and will be really useful for apps like make.com, zapier, n8n

Product Area

saas

[scott7414]

You can definetly create business custom fields and you can also retreive them.

URL
https://services.leadconnectorhq.com/custom-fields/

Body
{ "name": "Test Company Field", "dataType": "TEXT", "fieldKey": "test_company_field", "parentId": "k8jSXYtAhPbZooGPKOdR", "objectKey": "business", "description": "Description of company test field", "placeholder": "This is a placeholder", "showInForms": true, "locationId": "wAcbT1ozUU5MKeOM1uT5" }

URL
https://services.leadconnectorhq.com/locations/wAcbT1ozUU5MKeOM1uT5/customFields/search

Query Parmeters
{ "model": "business", "documentType": "field", "includeStandards": false }

[i-am-rad]

Businesses can be searched on the records API. The object is "business" and use the same filters as the standard object searches.

https://marketplace.gohighlevel.com/docs/ghl/objects/search-object-records

@karthik-highlevel - there should be a page under the business api section to point to this page for "search"

[dimmisel]

Businesses can be searched on the records API. The object is "business" and use the same filters as the standard object searches.

https://marketplace.gohighlevel.com/docs/ghl/objects/search-object-records

@karthik-highlevel - there should be a page under the business api section to point to this page for "search"

I will try this then, thanks!

[dimmisel]

You can definetly create business custom fields and you can also retreive them.

URL https://services.leadconnectorhq.com/custom-fields/

Body { "name": "Test Company Field", "dataType": "TEXT", "fieldKey": "test_company_field", "parentId": "k8jSXYtAhPbZooGPKOdR", "objectKey": "business", "description": "Description of company test field", "placeholder": "This is a placeholder", "showInForms": true, "locationId": "wAcbT1ozUU5MKeOM1uT5" }

URL https://services.leadconnectorhq.com/locations/wAcbT1ozUU5MKeOM1uT5/customFields/search

Query Parmeters { "model": "business", "documentType": "field", "includeStandards": false }

I don't want to create custom fields, I want to create a business and add data to my current Business custom fields. Is this possible?
I cannot in my last try with 422 error

[scott7414]

You have to use the create a record endpoint then which you can create a business there and update its custom fields.

https://services.leadconnectorhq.com/objects/business/records

{
    "locationId": "wAcbT1ozUU5MKeOM1uT5",
    "properties": {
        "name": "Test Company",
        "phone": "+13145558787",
        "company_size": "50_plus",
        "founded_date": "2015-03-01T06:00:00.000Z",
        "annual_revenue": {
            "value": 1000000,
            "currency": "default"
        }
    }
}

[i-am-rad]

Hop on slack to ask questions as you will get answers much faster on things. https://join.slack.com/t/ghl-developer-council/shared_invite/zt-335czqahh-YBDlql0tUPtEwFjMKgWsGQ

[github-actions]

✅ Issue processed successfully!

Your issue has been reviewed and assigned to the appropriate team.

[gauravkanted-ghl]

Thank you for contributing @i-am-rad @scott7414.
Since this functionality is already available.
We will close this ticket. @dimmisel. Feel free to jump onto slack to get any more queries resolved.