Search for companies by domain | Companies API

Method Details

HTTP Methods:

POST

Content Type:

application/json

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Headers

Products:

Marketing & CRM

Required Scope:

crm.objects.companies.read

This endpoint is used to search for companies by domain name.

Use case for this endpoint: This can be used to search for existing companies based on an exact match to the domain property.

Response details

If the request is successful, this method returns a list of company records, since the domain isn't required to be unique. Up to 100 records can be included in a single response.

Required parameters	How to use	Description
OAuth access token or private app access token	Authorization: Bearer {token} header	Used to authenticate the request. Please see this page for more details about authentication.
Limit	`"limit": 100` Included in the request body	The number of records to return in a single request. Supports values up to 100.
Properties	`"requestOptions": { "properties": [] }` Included in the request body	A list of properties that will be included for the returned companies. By default, no properties will be included in the response, so you must specify any properties that you want.
Offset	`"offset": { "isPrimary": true, "companyId": 0 }` Included in the request body	Each response will include a `hasMore` value and an offset object. If `hasMore` is `true`, then you would use the offset object in the next request to get the next set of results.

JSON

Example POST URL: https://api.hubapi.com/companies/v2/domains/hubspot.com/companies Example POST body: { "limit": 2, "requestOptions": { "properties": [ "domain", "createdate", "name", "hs_lastmodifieddate" ] }, "offset": { "isPrimary": true, "companyId": 0 } } Example response: { "results": [ { "portalId": 62515, "companyId": 184896670, "isDeleted": false, "properties": { "hs_lastmodifieddate": { "value": "1502872954691", "timestamp": 1502872954691, "source": "CALCULATED", "sourceId": null, "versions": [ { "name": "hs_lastmodifieddate", "value": "1502872954691", "timestamp": 1502872954691, "source": "CALCULATED", "sourceVid": [ ] } ] }, "domain": { "value": "hubspot.com", "timestamp": 1457708103847, "source": "COMPANIES", "sourceId": null, "versions": [ { "name": "domain", "value": "hubspot.com", "timestamp": 1457708103847, "source": "COMPANIES", "sourceVid": [ ] } ] }, "name": { "value": "Hubspot, Inc.", "timestamp": 1457708103906, "source": "BIDEN", "sourceId": "name", "versions": [ { "name": "name", "value": "Hubspot, Inc.", "timestamp": 1457708103906, "sourceId": "name", "source": "BIDEN", "sourceVid": [ ] } ] }, "createdate": { "value": "1457708103847", "timestamp": 1457708103847, "source": "API", "sourceId": null, "versions": [ { "name": "createdate", "value": "1457708103847", "timestamp": 1457708103847, "source": "API", "sourceVid": [ ] } ] } }, "additionalDomains": [ ], "stateChanges": [ ], "mergeAudits": [ ] }, { "portalId": 62515, "companyId": 418736767, "isDeleted": false, "properties": { "hs_lastmodifieddate": { "value": "1498644245669", "timestamp": 1498644245669, "source": "CALCULATED", "sourceId": null, "versions": [ { "name": "hs_lastmodifieddate", "value": "1498644245669", "timestamp": 1498644245669, "source": "CALCULATED", "sourceVid": [ ] } ] }, "domain": { "value": "hubspot.com", "timestamp": 1490280388204, "source": "API", "sourceId": null, "versions": [ { "name": "domain", "value": "hubspot.com", "timestamp": 1490280388204, "source": "API", "sourceVid": [ ] } ] }, "name": { "value": "qweqwe2323", "timestamp": 1490280388204, "source": "API", "sourceId": null, "versions": [ { "name": "name", "value": "qweqwe2323", "timestamp": 1490280388204, "source": "API", "sourceVid": [ ] } ] }, "createdate": { "value": "1490280388204", "timestamp": 1490280388204, "source": "API", "sourceId": "API", "versions": [ { "name": "createdate", "value": "1490280388204", "timestamp": 1490280388204, "sourceId": "API", "source": "API", "sourceVid": [ ] } ] } }, "additionalDomains": [ ], "stateChanges": [ ], "mergeAudits": [ ] } ], "hasMore": true, "offset": { "companyId": 418736767, "isPrimary": true } }